Skip to main content

Konfiguration

Allgemeine Informationen​

Der Insiders Connector wird mit einer Standardkonfiguration bereitgestellt. Die Konfigurationsdateien befinden sich im Verzeichnis:
D:\EASY\OUC-Tools\InsidersConnector\config_template

Bei der Erstkonfiguration muss config_template entsprechend zu config umbenannt werden.

Ordnerstruktur​

Ordner:

  • mapping: Enthält Strukturmapping-Dateien.
  • tasks: Enthält alle definierten Tasks.

Dateien:

  • insiders.json: Enthält Verbindungsinformationen.
  • logging.json: Konfiguration der Protokollierung.

Verbindungsinformationen​

Die Verbindungsinformationen werden in der Datei insiders.json gespeichert.

Wichtige Parameter​

  1. restUrl:
    Muss abhängig vom System (Test/Prod) konfiguriert werden:

    • Test: https://api.staging.de.insiders.cloud/1/rest/
    • Produktion: https://api.production.de.insiders.cloud/1/rest/

  2. loginData.username: Benutzername des API-Benutzers.

  3. loginData.password: Passwort des API-Benutzers (kann zwischen Test und Prod unterschiedlich sein).

  4. loginData.envUsername: Umgebungsvariable für den Benutzername des API-Benutzers

  5. loginData.envPassword: Umgebungsvariable für das Passwort des API-Benutzers oder den API-Key

  6. subsystem: Optionaler Standardmandant.

info

Die Login-Parameter loginData.username und loginData.password haben Vorrang.

Zusätzlich bieten die Optionen über Umgebungsvariablen (siehe loginData.envUsername und loginData.envPassword) eine transparente Alternative, um unterschiedliche Werte für Entwicklungs- und Produktionsumgebungen bereitzustellen.

Falls keine der beiden Optionen verfügbar ist, wird ein Fehler ausgelöst.

Beispieldatei​

{
    "restUrl": "https://api.staging.de.insiders.cloud/1/rest/",
    "MaxRecordsetSizePerUploadRequest": 500,
    "rollbackOnUploadError": false,
    "commitStrategy": "BestEffort",
    "transactionStatusQueryIntervalSeconds": 30,
    "transactionTimeoutSeconds": 3600,
    "xApiKey": "some-x-api-key",
    "loginData": {
        "username": "",
        "password": "",
        "envUsername": "INSIDERS_USER",
        "envPassword": "INSIDERS_API_KEY"
    },
    "subsystem": "InvoiceTables"
}

Logging​

Das Logging ist standardmäßig deaktiviert, kann aber aktiviert werden.

Aktivierung der Protokollierung​

  • Über Programmparameter:
    insidersconnector.exe --v --task=analyse
  • Über Konfigurationsdatei:
    Setzen Sie "verbose": true in der Datei logging.json.

Beispieldatei: logging.json​

{
    "verbose": false,
    "level": "silly",
    "state": {
        "connection": {
            "user": "user",
            "password": "pwd",
            "server": "server",
            "database": "database",
            "debug": true,
            "port": 1433,
            "options": {
                "trustedConnection": false,
                "encrypt": false
            }
        },
        "tableName": "InsidersStateLogging"
    }
}

Logging-Level​

Das Logging-Level wird über den Parameter "level" gesteuert. Mögliche Werte sind:

  • silly
  • debug
  • info
  • warn (Standard)
  • error

Protokollierung in einer Datenbank​

Zusätzlich zur Datei-Protokollierung kann der Programmaufruf in einer Datenbank protokolliert werden. Dazu muss die state-Sektion in der Datei logging.json hinzugefügt werden.

Erstellen der Datenbanktabelle​

Führen Sie folgendes SQL-Skript aus, um die benötigte Tabelle zu erstellen:

CREATE TABLE InsidersStateLogging (
    Id uniqueidentifier NOT NULL,
    Taskname varchar(max) NOT NULL,
    Started datetime NULL,
    Ended datetime NULL,
    Successful bit NULL DEFAULT (0),
    Result varchar(max) NULL,
    CONSTRAINT PK_InsidersStateLogging_Id PRIMARY KEY CLUSTERED (Id)
)

Beispielkonfiguration​

{
    "state": {
        "connection": {
            "user": "user",
            "password": "pwd",
            "server": "server",
            "database": "database",
            "debug": true,
            "port": 1433,
            "options": {
                "trustedConnection": false,
                "encrypt": false
            }
        },
        "tableName": "InsidersStateLogging"
    }
}

Log-Dateien​

Die Log-Dateien werden im Verzeichnis D:\EASY\OUC-Tools\InsidersConnector\logs gespeichert.