Einrichtung ReWe Modul mit DATEVconnect

Diese Dokumentation dient der Einführung in die Arbeit und der Einrichtung des ReWe Moduls und die Anbindung von DATEV über die DATEVconnect API.

0. Aufbau

Der relevante Ordner setzt sich aus verschiedenen Komponenten und Skripten zusammen:

• setup: Enthält alles rund um den Modellaufbau – z. B. das Einspielen von Modulen, die Installation benötigter Bibliotheken usw.

• log: Hier werden die Logdateien bei der Ausführung der Skripte abgelegt.

• config: Beinhaltet die zentrale Konfigurationsdatei (config File), auf die die Skripte zugreifen.

• .bat-Dateien: Zwei Batch-Dateien, mit denen der API-Abruf ins Staging auch außerhalb von OCT getestet werden kann.

• Python-Skripte: Die eigentlichen Ausführungsskripte befinden sich ebenfalls im Ordner.

• versionsinfo.txt: Eine Textdatei mit Versionsinformationen.

1. Voraussetzungen

Es muss ein leeres OCT-System (ab Version 5.10.) installiert sein, inklusive einer zugehörigen OCT-Datenbank. Dabei ist unbedingt darauf zu achten, dass keine weiteren Module oder Konnektoren eingespielt werden.

Außerdem müssen Zugangsdaten zur DATEV API vorhanden sein – also:
URL, Benutzername und Passwort.

Zusätzlich wird der benötigte Ordner mit allen relevanten Files aus folgendem Repository bereitgestellt: WIRD NOCH ERGÄNZT
Aus Konventionsgründen wird dieser Ordner unter folgendem Pfad abgelegt:

C:\ProgramData\Saxess Software\DATEVconnect

Der Ordnername sollte exakt so lauten, um spätere Referenzen innerhalb der Skripte korrekt aufzulösen.

2. Vorbereitung CONFIG File

Nach dem Öffnen des Ordners sehen wir folgende Struktur und navigieren als Erstes zum CONFIG-File im Unterordner config.

Anschließend tragen wir die markierten Daten in das CONFIG File ein:

Beachte:

sql_winauth = 0 → Authentifizierung über SQL User

sql_winauth = 1 → Authentifizierung über Windows User (SQL Username und PW bleiben hier leer)

Wichtig ist auch, darauf zu achten, dass sich keine versteckten Leerzeichen oder sonstige Formatierungsfehler einschleichen, die den JSON ungültig machen.
Das Skript liefert in diesem Fall keine detaillierte Fehlermeldung – außer, dass das CONFIG-File im angegebenen Pfad nicht gefunden wurde.
Der eigentliche Fehler liegt dann aber meist an einem Formatierungsproblem im JSON selbst.

3. Einspielen des ReWe Moduls

Anschließend öffnen wir den Setup Ordner und öffnen SETUP_REWE_DATEVConnect.sql im Management Studio. Das Skript führen wir auf der OCT Datenbank aus.

Dieser Schritt ersetzt den sonst üblichen Vorgang des Moduleinspielens über die OCT-Oberfläche.

In OCT selbst sollte sich anschließend automatisch eine Sammlung an Pipelines aufgebaut haben.
Auch im Datenerfassungsbereich wurden dabei bereits verschiedene Objekte erstellt.

Das leere ReWe Modul ist somit erfolgreich in OCT eingespielt.

4. API Abruf testen

4.1. Steuerungstabelle konfigurieren

Im nächsten Schritt testen wir den manuellen Abruf der DATEV API in das Staging-Schema des Moduls.

Dafür ist zunächst die Installation der notwendigen Python Libraries erforderlich.
Führe dazu die .bat-Datei mit dem Namen “install libraries” aus.

→ Wichtig: Die Datei unbedingt als Administrator ausführen!

Anschließend bearbeiten wir die Steuerungstabelle.
Öffne dafür im setup-Ordner das SQL-File “Gatewaysteuerung” im Management Studio, führe es jedoch nicht vollständig aus.

Mit diesem File können die Mandantenkonfigurationen angepasst werden.

Markiere zunächst nur die erste Zeile und führe diese mit F5 aus, um die Default-Konfigurationen anzuzeigen.

Das sieht wie folgt aus:

Nun wollen wir entsprechend der Anforderungen aus dem Setup Call die Anpassungen vornehmen.

• Relevant ist hier, welche Daten übernommen werden sollen, also ob FIN, KOST, OP, AV oder mehrere (OP und AV sind derzeit noch nicht implementiert).

• In unserem Beispiel wollen wir FIN und KOST ab dem 01.01.2023 abrufen, und zwar für beide Mandanten.

• Um das zu hinterlegen, gehen wir erneut in das Skript der Gatewaysteuerung zum Punkt "Mandantenaktivierung mit Bestandsauswahl".

• die relevanten Kategorien setzen wir auf 1 und passen das Startjahr der Extraktion an

• anschließend markieren wir wieder den relevanten Updatebefehl einzeln und führen mit F5 aus

• Nun geben wir mit dem ersten Befehl die überarbeitete Steuerungstabelle aus und prüfen auf Richtigkeit!

4.2. Abruf ins Staging

In der ersten Ebene des Ordners befinden sich zwei .bat-Dateien:

1_Steuerungstabelle aktualisieren.bat
2_Daten abrufen.bat

• Diese werden in genau dieser Reihenfolge ausgeführt. Der Vorgang kann durchaus einige Zeit in Anspruch nehmen.

• Wenn die Skripte durchgelaufen sind, kann in den Staging-Tabellen überprüft werden, ob die Daten angekommen sind. Andernfalls würde dies auch im Skriptlog entsprechend vermerkt.

→ der initiale Abruf hat funktioniert

5. Modell- und Pipelinekonfiguration in OCT

5.1. Modellkonfiguration

Damit die Kontenzuordnungen korrekt funktionieren müssen wir als erstes das Datenmodell einpflegen. Das geht über den Datenerfassungsbereich und die Factory Modellierung.

• Darin befinden sich die Ordner Productlines, Strukturen, Zuordnungen und Templates.

• Aus den Templates kopieren wir als erstes das Product “Kontenstruktur HGB" in den Ordner Strukturen.

• Dann kopieren wir den Kontenrahmen aus dem Ordner Templates in den Ordner Zuordnungen.

• Welcher Kontenrahmen verwendet wird, lässt sich aus der Steuerungstabelle ablesen, unter dem Feld account_system (siehe Screenshot Steuerungstabelle).

Nachdem die Zuordnung vorgenommen wurde wird die MODEL Pipeline (Schritt 1-3) ausgeführt:

Die Modellierung ist somit abgeschlossen!

5.2. Pipelinekonfiguration

Das Ziel in diesem Schritt ist es, die Importpipeline zu konfigurieren. Diese sorgt dafür, dass der zuvor über die .bat-Dateien getestete Abruf in OCT eingebunden wird und die Daten aus dem Staging-Bereich in die Schemata integration und result überführt werden.

Schritte:

• 1. “Steuerungstabelle aktualisieren” & “staging ausführen”

  • hier muss der Pfad des Skriptordners hinterlegt werden

• 2. “Mandantenjahre für Übernahme definieren”

  • hier wird die Auswahl zu Extraktionszeitraum und Art der Daten, analog zu der manuellen Steuerungstabelle aus 4.1. hinterlegt

• 3. MandantenID’s hinterlegen in den Schritten:

  • “integration Stammdaten aufbauen (Mandanten definieren)”

  • “agent.spREWE_Dimensionsaufbau (Mandanten definieren)“

  • “agent.spREWE_Faktenaufbau (Mandanten definieren)“

4. MandantenID und Datentypauswahl ergänzen in “integration Bewegungsdaten aufbauen (Mandanten definieren)”

• in diesem Step wird zusätzlich zu der MandantenID noch einmal ausgewählt ob FIN, KOST, OP übertragen wird

• wird analog zur Steuerungstabelle ausgefüllt

Nun kann die Pipeline nach dem Speichern ausgeführt werden!

Im Anschluss kann im Bereich Validierung der Import nach integration und result überprüft werden!

6. CP Prozeduren einspielen

Bei CP Kunden muss noch zusätzlich ein weiteres Modul eingespielt werden, analog zu SETUP_REWE_DATEVConnect.sql, es heißt jetzt aber SETUP_REWE_CP.sql. Nun wurden auch alle relevanten CP Prozeduren eingespielt! (Äquivalent zu FIN-CP)