Skip to main content

01 – Übersicht

Der SqueezeConnector-Import holt fertig gelesene Belege per Squeeze REST-API v2 nach DOCUMENTS ab und legt je Beleg eine neue Mappe an. Diese Seite beschreibt Funktionsweise, Ablauf und Grenzen der Variante ohne Duplikatsprüfung. 

Was ist der SqueezeConnector-Import

Der Import ist die schlanke Variante des Squeeze Pull-Jobs. DOCUMENTS holt die Belege selbst über die REST-API v2 von Squeeze ab, der SOAP-Export der Klasse entfällt. Je Squeeze-Klasse gibt es ein eigenes Job-Skript, das im Scheduler läuft und runSqueezeImport aufruft.

Der Job fragt im Queue-Step „Export“ die Belege der konfigurierten Squeeze-Klasse ab. Je Beleg legt er immer eine neue Mappe an, schreibt die Kopffelder (optional auch Positionen und Anhänge) und meldet den Beleg danach über das Export-Interface „Pull“ als FINISHED an Squeeze. Erst dann verlässt der Beleg den Export.

Das Mapping bleibt in Squeeze: Maßgeblich ist der externalName jedes Feldes und jeder Tabellenspalte der Squeeze-Klasse. Er muss dem technischen Feldnamen in DOCUMENTS entsprechen. Denselben Wert nutzt der SOAP-Export, beim Umstieg bleibt das Mapping also unverändert. In DOCUMENTS gibt es keine Mapping-Tabelle.

Die Bibliothek ist eigenständig. Sie braucht keine DEXPRO-Solution und keine Parameter und läuft unter DOCUMENTS 5 und 6 (Windows und Linux).

Abgrenzung zum Pull-Job mit Duplikatsprüfung

  Pull-Job (runSqueezePull) Import (runSqueezeImport)
Vorhandene Mappe suchen (SqueezeID/externalId) ja nein, immer neue Mappe
Feld SqueezeStatus, Workflow-Start ja nein, liegt beim Aufrufer
Pflichtfelder am Mappentyp SqueezeID, SqueezeStatus, Register keine
Anhänge Standard ja nur mit register
Positionen Standard ja nur mit positionsField
Sperre gegen parallele Läufe ja ja

Ohne Duplikatsprüfung erkennt der Job nicht, ob es zu einem Beleg schon eine Mappe gibt. Jeder Beleg, der im Export-Step liegt, erzeugt eine neue Mappe. Die Folgen sind im Abschnitt „Grenzen“ und auf der Seite Betrieb und Fehlersuche beschrieben.

Skripte

Skript Zweck
SqueezeConnector_Lib Die Bibliothek. Sie legt nur das globale Objekt SqueezeConnector an (Verbindung, Lesen, Schreiben, FINISHED melden).
SqueezeConnector_Import runSqueezeImport(config, log): der komplette Lauf für eine Squeeze-Klasse
SqueezeConnector_JOB_Import Job-Vorlage. Je Squeeze-Klasse eine Kopie.

Was bei jedem Lauf passiert

Zuerst prüft der Job die Voraussetzungen. Ist eine nicht erfüllt, holt er nichts ab und schreibt den Grund ins Log.

  • In der Konfiguration stehen fileType und squeezeClass.
  • Der Benutzer aus scriptUser lässt sich setzen. Ohne Benutzer kann DOCUMENTS keine Mappe anlegen.
  • Die Zugangsdaten sind vorhanden, in der Job-Konfiguration oder in SqueezeConfig.js.
  • Das Export-Interface „Pull“ ist an der Squeeze-Klasse vorhanden und aktiv.
  • Für den Mappentyp läuft gerade kein anderer Import.

Danach holt der Job die Liste aller Belege der Klasse im Queue-Step „Export“ und verarbeitet sie nacheinander, höchstens maxDocuments pro Lauf (Standard 100). Je Beleg:

  1. Beleg lesen: Kopffelder, Positionen und die Liste der Anhänge aus Squeeze. Steht der Beleg inzwischen nicht mehr im Export-Step, wird er übersprungen.
  2. Mappe anlegen: eine neue Mappe vom Typ fileType.
  3. Daten übernehmen: Kopffelder schreiben, optional Positionen und Anhänge übernehmen, Mappe speichern.
  4. FINISHED melden: Der Beleg verlässt in Squeeze den Export.

Schlägt Schritt 3 fehl, löscht der Job die Mappe wieder und meldet kein FINISHED. Der Beleg bleibt im Export, der nächste Lauf versucht es erneut.

Ein Fehler bei einem Beleg bricht den Lauf nicht ab, der Job macht mit dem nächsten Beleg weiter. Ausnahme: Fehlt ein Anhang-Register am Mappentyp, bricht der Lauf ab, und die restlichen Belege bleiben im Export.

Zähler und Rückgabewert

runSqueezeImport liefert Zähler zurück. Dieselben Werte stehen in der letzten Logzeile.

Zähler Logtext Bedeutung
ok angelegt Mappe angelegt und Beleg als FINISHED gemeldet
error fehlerhaft Lesen, Anlegen, Übernahme oder FINISHED-Meldung gescheitert
aborted abgebrochen Unerwarteter Fehler (Exception) bei einem Beleg
skipped noch nicht fertig Beleg stand beim Lesen nicht mehr im Export-Step
deferred auf den nächsten Lauf verschoben Obergrenze erreicht, Register fehlt oder Sperre verloren
total gesamt im Step Belege der Klasse im Export-Step zu Beginn des Laufs

Die Job-Vorlage meldet den Lauf als fehlgeschlagen (context.returnValue = -1), sobald error oder aborted größer 0 ist oder ein Fehler über log.err gemeldet wurde.

Grenzen

Ohne register gehen die Anhänge verloren. Ist kein Register konfiguriert, entsteht die Mappe ohne Beleg-PDF. Im Log steht nur ein Hinweis, der Beleg wird trotzdem als FINISHED gemeldet und verschwindet aus dem Export. Dasselbe gilt für Positionen ohne positionsField. Beide Optionen deshalb immer setzen, wenn Anhänge bzw. Positionen gebraucht werden.

  • FINISHED-Meldung gescheitert: Die Mappe bleibt stehen, der Beleg bleibt im Export. Der nächste Lauf legt eine zweite Mappe an. Im Log steht dazu ein FEHLER.
  • Unerwarteter Fehler nach dem Anlegen: Tritt nach dem Anlegen der Mappe eine Exception auf, bleibt die unvollständige Mappe stehen. Der Beleg wird nicht als FINISHED gemeldet, der nächste Lauf legt eine weitere Mappe an.
  • Squeeze nicht erreichbar: Ist Squeeze nicht erreichbar, der API-Key ungültig oder die Klasse nicht vorhanden, wird die Klasse übersprungen. Das steht nur als Information im Log, der Job meldet keinen Fehler. Das Log deshalb regelmäßig prüfen.
  • Kein Rückverweis in Squeeze: Die FileID der Mappe wird nicht an Squeeze gemeldet (nur über die v1-API möglich). Die Zuordnung Beleg → Mappe gibt es nur über squeezeIdField und das Log.
  • Sperre je Mappentyp: Zwei Jobs für verschiedene Squeeze-Klassen, die in denselben Mappentyp schreiben, blockieren sich gegenseitig. Der zweite Lauf wird übersprungen. Solche Jobs zeitversetzt einplanen.