OCT-Datenintegration

Installationsanleitung gateway.businesscentral

Diese Seite führt sie durch die Installation des Gateways in der Cloud oder on-premises.


Voraussetzungen

Business Central / Azure Portal

OCT

  • OCT Version 5.11 oder höher - je nach Einrichtungsvariante lokal oder in der Azure Cloud

  • eine OCT-Datenbank muss als Zieldatenbank On-Premises oder in einer Cloudumgebung erreichbar seinTechnische Einrichtung

Variante Cloud - Einrichtung des Gateways mit OCT in der Saxess-Cloud

Zusätzliche Voraussetzungen:

  • Azure Storage Account mit Kontoname und Zugriffsschlüssel (Access Key)

Installationsanleitung:

Schritt A - Vorbereitung, Konfiguration und Upload

A1. Azure-Dateifreigabe vorbereiten

Im Azure Storage Account wird eine Dateifreigabe für das Gateway eingerichtet. Der Zugriff kann entweder über den Microsoft Azure Storage Explorer oder über das Azure Portal erfolgen.

Im Storage Account eine neue Dateifreigabe anlegen, zum Beispiel:

python

Alternativ kann ein anderer Dateifreigabename verwendet werden, dieser muss dann später bei der Konfiguration in OCT angepasst werden.

Innerhalb der Dateifreigabe einen Ordner für das Gateway anlegen, zum Beispiel:

Gateway_BusinessCentral

Alternativ kann ein anderer Ordnername verwendet werden. Dieser Name muss später bei der Konfiguration in OCT entsprechend berücksichtigt werden.

A2. Gateway-Release vorbereiten

Den Gateway-Archiv herunterladen und lokal entpacken, zum Beispiel:

Gateway_Businesscentral_v1.2.0

Im entpackten Releaseordner den Unterordner config öffnen.

In der Datei config.jsondie erforderlichen Business Central Zugangsdaten und Zielsysteminformationen eintragen:

  • Umgebung

  • api_client_id

  • api_client_secret

  • api_tenant_id

  • Zieldatenbank-Verbindungsdaten

  • optional: Startdatum, Mandanten, Custom_Endpoints

Falls der Name der Konfigurationsdatei geändert wird, muss dieser später im Startbefehl des Container-Steps in OCT entsprechend angepasst werden.

A3. Gateway-Dateien in die Azure-Dateifreigabe hochladen

Den vollständigen Inhalt des entpackten Gateway-Releaseordners in den zuvor angelegten Ordner der Azure-Dateifreigabe hochladen.

Beispiel-Zielpfad:

python/Gateway_BusinessCentral/

Dabei sollte die Ordnerstruktur des Releasepakets unverändert bleiben, insbesondere der Unterordner wie config.

A4. Azure-Dateifreigabe in OCT als Datenquelle registrieren

In OCT wird die Azure-Dateifreigabe als Datenquelle registriert.

In OCT folgenden Bereich öffnen:

Datenflüsse → Datenquellen

Eine neue Datenquelle vom Typ Azure Storage (Azure Storage-Typ: File-Storage) anlegen.

Die erforderlichen Angaben eintragen:

  • Name der Datenquelle

  • Storage-Kontoname

  • Azure-Storage-Zugriffschlüssel

  • Dateifreigabename (entspricht dem Namen aus Schritt 1)

  • Verbindung testen und danach die Datenquelle speichern.

Weitere Informationen zur Einrichtung sind im OCT-Handbuch beschrieben: https://help.onecooltool.de/oct-handbuch/v2026.02/3-2-1-6-azure-storage

Schritt B - Einspielen des Setupskripts

B1. Datenbankobjekte in der OCT-Datenbank einspielen

Im SQL Server Management Studio das Setup-Script für die Business-Central-Staging-Objekte ausführen.

Gateway_BusinessCentral_v1.2.0/setup/SETUP_STAGING_BUSINESSCENTRAL.sql

Das Script muss gegen die jeweilige OCT-Datenbank ausgeführt werden.

Vor der Ausführung prüfen, ob die richtige OCT-Datenbank ausgewählt ist.

Schritt C - Konfiguration der OCT-Pipeline

C1. OCT-Prozesspipeline konfigurieren

In OCT den Bereich öffnen:

Datenflüsse → Prozesspipelines

Anschließend die Pipeline für den Business-Central-Datenabruf öffnen.

GWBC - Datenextraktion Business Central

In der Pipeline folgende Anpassungen vornehmen:

Folgende Steps löschen oder deaktivieren, diese werden für die Cloud-Variante nicht benötigt:

  • Powershell - Steuerungstabelle laden

  • Powershell - Datenextraktion Business Central

  • Python - Steuerungstabelle laden

  • Python - Datenextraktion Business Central

Den Container-Step Steuerungstabelle aufklappen.

Im Container-Step die im Schritt A1 angelegte Azure File Share -Datenquelle auswählen.

Den Startbefehl prüfen und bei Bedarf anpassen.

Der Startbefehl muss auf die korrekte Konfigurationsdatei und main.py verweisen. Wenn die Datei weiterhin config.json heißt, ist in der Regel keine Anpassung erforderlich. Wurde die Datei umbenannt, muss der neue Dateiname im Startbefehl eingetragen werden.

python,run.py,--ScriptName=BusinessCentral_1.2.0/main.py,--ScriptArguments=--config=config.json --modus=1

Analog dazu muss der Container-Step “Datenextraktion Business Central” angepasst werden.


Variante On-Premises - Einrichtung des Gateways mit OCT auf einem Server

Zusätzliche Voraussetzungen:

Installationsanleitung:

Schritt A - Vorbereitung, Konfiguration, Pythonumgebung einrichten

A1. Gateway Release auf den Server kopieren/herunterladen

Gateway-Archiv bereitstellen

Zunächst wird das Gateway-Deploymentpaket auf dem OCT-Applikationsserver bereitgestellt.

Das Gateway-Archiv aus dem Storage Account herunterladen:

Gateway_BusinessCentral_v1.2.0.zip

Die ZIP-Datei auf den OCT-Applikationsserver kopieren, zum Beispiel nach:

C:\ProgramData\Saxess Software

Alternativ kann ein anderer Ablageort verwendet werden. In diesem Fall müssen die Pfade in den späteren OCT-Pipeline-Steps entsprechend angepasst werden.

Das Archiv entpacken.

Beispiel-Zielordner:

C:\ProgramData\Saxess Software\Gateway_BusinessCentral_v1.2.0

Nach dem Entpacken müssen unter anderem die folgenden Ordner und Dateien vorhanden sein:

config\config.json
setup\SETUP_STAGING_BusinessCentral.sql
requirements.txt
install_libraries_(als_Admin_ausführen).bat
1_Steuerungstabelle_aktualisieren.bat
2_Daten_abrufen.bat

A2. Lokale Python-Umgebung vorbereiten

Auf dem OCT-Applikationsserver muss eine lokale Python-Umgebung für die Ausführung der OCT-Gatewaypakete vorhanden sein. (Eine lokale Python Umgebung einrichten )

Vor der weiteren Einrichtung prüfen:

Ist Python auf dem OCT-Applikationsserver installiert?
Ist Python über die Kommandozeile aufrufbar?
Ist pip verfügbar?

Prüfung über ein CMD-Terminal:

python --version
python -m pip --version

Falls Python nicht gefunden wird, muss Python installiert oder der Pfad zur Python-Installation in den OCT-Pipeline-Steps explizit hinterlegt werden.

A3. Benötigte Python-Pakete installieren

Die benötigten Python-Pakete werden aus dem entpackten Gateway-Ordner installiert.

Variante 1: Installation über Batch-Datei

Die Batch-Datei im Gateway-Ordner als Administrator ausführen:

install_libraries_(als_Admin_ausführen).bat

Variante 2: Manuelle Installation über CMD

Alternativ können die Pakete manuell über ein CMD-Terminal installiert werden.

Ein CMD-Terminal als Administrator starten.

In den entpackten Gateway-Ordner wechseln:

cd /d "C:\ProgramData\Saxess Software\Gateway_BusinessCentral_v1.2.0"

Die benötigten Python-Pakete installieren:

python -m pip install -r requirements.txt

Hinweis: Der Befehl cd /d ist robuster als cd ../../..., weil er auch funktioniert, wenn das CMD-Terminal auf einem anderen Laufwerk gestartet wurde.

Schritt B - Einspielen des Setupskripts

B1. Datenbankobjekte in der OCT-Datenbank einspielen

Im SQL Server Management Studio das Setup-Script für die Business-Central-Staging-Objekte ausführen.

Gateway_BusinessCentral_v1.2.0/setup/SETUP_STAGING_BUSINESSCENTRAL.sql

Das Script muss gegen die jeweilige OCT-Datenbank ausgeführt werden.

Vor der Ausführung prüfen, ob die richtige OCT-Datenbank ausgewählt ist.

Schritt C - Konfiguration der OCT-Pipeline

C1. OCT-Prozesspipeline konfigurieren

In OCT den Bereich öffnen:

Datenflüsse → Prozesspipelines

Anschließend die Pipeline für den Business-Central-Datenabruf öffnen.

GWBC - Datenextraktion Business Central

In der Pipeline folgende Anpassungen vornehmen:

Folgende Steps löschen oder deaktivieren, diese werden für die Cloud-Variante nicht benötigt:

  • Container - Steuerungstabelle laden

  • Container - Datenextraktion Business Central

  • Powershell - Steuerungstabelle laden

  • Powershell - Datenextraktion Business Central

Den Container-Step Steuerungstabelle aufklappen.

In den Python-Steps den Pfad zum Gatewayordner, der in Schritt A1 definiert wurde, eintragen.

Der Wert des Parameters “config” muss auf die korrekte Konfigurationsdatei verweisen. Wenn die Datei weiterhin config.json heißt, ist in der Regel keine Anpassung notwendig.

Konfiguration der Datei config.json

Auswahl der abzurufenden Mandanten über Eintragung in die Mandantenliste

Output

"db_output_aktiv": 1

"csv_out_aktiv" : 1

Entscheidet ob die abgerufenen Daten in die Zieldatenbank geschrieben oder als CSV-Datei auf der Festplatte oder im Azure File Share abgespeichert werden sollen. 1 = aktiviert, 0 = deaktivert

Beide Optionen können gleichzeitig aktiv sein.

Bei Ausführung des Gateway-Skripts im Container-Step den “ziel_ordner” im Abschnitt “Dateisystem” freilassen, da das Skript dann die Daten im File-Share ablegt.