Installation
Diese Seite beschreibt Voraussetzungen, Einbau und Einbautest des SqueezeConnector-Imports. Die Optionen der Job-Konfiguration sind auf der Seite Konfiguration beschrieben.
Voraussetzungen
Squeeze
- REST-API v2 ist erreichbar. Der DOCUMENTS-Server kommt auf die Squeeze-URL.
- Es gibt einen API-Key mit Zugriff auf die Dokumentklasse, die Queue und die Export-Interfaces.
- Die Belege der Klasse durchlaufen den Queue-Step „Export“.
DOCUMENTS
- DOCUMENTS 5 oder 6.
- Der Mappentyp ist vorhanden. Die technischen Feldnamen entsprechen den
externalName-Werten in Squeeze. - Es gibt einen Benutzer mit Rechten auf den Mappentyp, der im Mandanten existiert (
scriptUser). - Für Anhänge: ein Dokumentenregister am Mappentyp.
- Für Positionen: ein Feld am Mappentyp, das die Positionen als JSON aufnimmt (z. B.
Gentable). - Optional: ein Textfeld für die Squeeze-ID des Belegs (z. B.
SqueezeID). Empfohlen, weil es der einzige Rückverweis von der Mappe auf den Beleg ist.
1. Squeeze vorbereiten
- Mapping prüfen: In der Dokumentklasse hat jedes Feld, das übernommen werden soll, als
externalName(Name im Zielsystem) den technischen Feldnamen aus DOCUMENTS. Dasselbe gilt für die Tabellenspalten. Felder und Spalten ohneexternalNamewerden nicht übernommen. - Export-Interface „Pull“ anlegen und aktivieren: An der Dokumentklasse ein Export-Interface mit dem Namen
Pullanlegen und aktiv schalten. Der Name muss exakt stimmen, auch in der Groß- und Kleinschreibung. Ein abweichender Name wird über die OptionexportInterfaceangegeben. - SOAP-Export der Klasse deaktivieren.
Pro Squeeze-Klasse darf nur ein Export aktiv sein: SOAP-Export oder Pull. Laufen beide, entstehen doppelte Mappen.
Ein externalName darf je Klasse nur einmal vergeben sein. Ist ein DOCUMENTS-Feld doppelt gemappt, steht ein Hinweis im Log, und es ist nicht festgelegt, welcher Wert in der Mappe landet.
2. Zugangsdaten hinterlegen
Ohne server und apiKey in der Job-Konfiguration liest der Import die Zugangsdaten aus SqueezeConfig.js, derselben Datei wie der Squeeze-Viewer.
Speicherort der Datei (die letzte zutreffende Zeile gilt):
| Mandanteneigenschaft | Pfad |
|---|---|
| keine | <DOCUMENTS-Installationsverzeichnis>/DEXPRO/Squeeze/SqueezeConfig.js |
$SqueezeFolderPath |
<Wert>/www/SqueezeViewer/SqueezeConfig.js |
$SqueezeServerConfigPath |
<Wert>/SqueezeConfig.js |
Mit $SqueezeConfigFileName lässt sich ein anderer Dateiname angeben. $SqueezeUseProxy = false schaltet die Proxy-Ermittlung von DOCUMENTS ab.
Inhalt der Datei: Ausgewertet wird das JSON ab der ersten geschweiften Klammer. Gibt es einen Block SqueezeConfig_<Mandantenkürzel>, gilt dieser, sonst die oberste Ebene.
var SqueezeConfig = {
"SqueezeConfig_meinmandant": {
"squeezeServer": "https://kunde.squeeze.one",
"squeezeApiKey": "...",
"squeezeCaCert": ""
}
}
squeezeCaCert ist optional und nennt eine PEM-Datei für die Zertifikatsprüfung.
Der API-Key gehört nicht in das Job-Skript. SqueezeConfig.js ist der Standardweg. server und apiKey in der Job-Konfiguration sind nur für Ausnahmen gedacht.
3. Skripte einspielen
Alle drei Skripte in den DOCUMENTS-Manager einspielen:
| Skript | Hinweis |
|---|---|
SqueezeConnector_Lib |
Gibt es je Server nur einmal. Ist auch der Pull-Job mit Duplikatsprüfung installiert, muss die neuere Fassung der Lib eingespielt sein. |
SqueezeConnector_Import |
Importiert SqueezeConnector_Lib |
SqueezeConnector_JOB_Import |
Vorlage, wird nicht direkt eingeplant |
4. Job-Skript je Squeeze-Klasse anlegen
SqueezeConnector_JOB_Importkopieren und sprechend benennen, z. B.Invoice_SqueezeConnector_JOB_Import.- In der Kopie
squeezeConfiganpassen:
var squeezeConfig = /** @type {Object.<string,any>} */ ({
fileType: "Invoice", // Mappentyp in DOCUMENTS
squeezeClass: "Invoices", // Squeeze-Klasse, Name oder ID
scriptUser: "dexadmin", // Benutzer mit Rechten auf den Mappentyp
register: "Documents", // Register für die Anhänge
positionsField: "Gentable", // Feld für die Positionen
squeezeIdField: "SqueezeID" // Feld für die Squeeze-ID
});
- Das Logging der Vorlage schreibt mit
util.outins Server-Log (Präfix[SqueezeImport]). Bei Bedarf durch das eigene Logging ersetzen: ein Objekt mit den Funktionenlog.info(text)undlog.err(text).
Die ausgelieferte Vorlage enthält nur fileType, squeezeClass und scriptUser. register und positionsField müssen ergänzt werden, sonst werden Anhänge und Positionen nicht übernommen und der Beleg trotzdem als FINISHED gemeldet.
5. Verbindung testen
Vor dem ersten Lauf die Verbindung mit einem kurzen Testskript prüfen. Es schreibt nichts.
// #import "SqueezeConnector_Lib"
var fileCfg = SqueezeConnector.readConfigFile();
if (fileCfg.error !== "") {
util.out(fileCfg.error);
} else {
var sqz = new SqueezeConnector(fileCfg.connection);
var chk = sqz.checkConnection();
util.out(chk.status + " " + chk.errorMessage + " " + JSON.stringify(chk.data));
var pull = sqz.getExportInterface("Invoices");
util.out(pull.status + " " + pull.errorMessage + " " + JSON.stringify(pull.data));
}
Erwartet wird zweimal OK. Die erste Zeile zeigt die Squeeze-Version und alle Dokumentklassen mit ID und Name, die zweite das Export-Interface mit active: true.
6. Einbautest
- Einen Testbeleg in Squeeze bis in den Queue-Step „Export“ bringen.
- Im Job-Skript vorübergehend
maxDocuments: 1undtestKeepInExport: truesetzen. - Das Job-Skript einmal manuell ausführen.
- Im Log prüfen:
Dokument <ID> - Mappe <FileID> angelegt, gesetzte Felder: …. Hinweise zu fehlenden Feldern und Typabweichungen beachten. - Die Mappe prüfen: Kopffelder, Positionen, Anhänge im richtigen Register, Umlaute.
- Die Testmappe löschen.
testKeepInExportundmaxDocumentswieder entfernen.- Das Job-Skript erneut ausführen. Der Beleg muss danach in Squeeze den Export-Step verlassen haben.
Testmodus nie eingeplant laufen lassen. Mit testKeepInExport: true wird kein FINISHED gemeldet. Jeder Lauf legt für dieselben Belege erneut Mappen an.
7. Job einplanen
Das Job-Skript im DOCUMENTS-Manager als Job einplanen, z. B. viertelstündlich. Je Squeeze-Klasse ein Job. Schreiben mehrere Klassen in denselben Mappentyp, die Jobs zeitversetzt einplanen, weil die Sperre je Mappentyp gilt.
[BILD 03 – DOCUMENTS-Manager: eingeplanter Job]
Pro Squeeze-Instanz darf nur ein DOCUMENTS-System abholen. Test- und Produktivsystem dürfen nicht gleichzeitig dieselbe Klasse abholen, sonst fehlen die Belege im jeweils anderen System.


No comments to display
No comments to display