Skip to main content

Einrichtung der Verbindung zu Squeeze

  • Allgemein

Damit Squeeze in Invoice verwendet werden kann, muss zunächst die Verbindung zu Squeeze eingerichtet werden. Die passenden Konfigurations hierfür befindet sich in der Administrations-Outbar in der Sub-Outbar "Allgemein" unter "Verbindung"-> "Squeeze" bzw. in der Outbar "Squeeze" unter "Verbindung":

image-1606223447940.png

Erst wenn in dieser Konfiguration alle Daten valide sind, können Order wie z.B. "Dokumentenklassen" verwendet werden. Vorher ist ein Zugriff auf Daten aus Squeeze nicht möglich.

 

Konfigurationsfelder

Wichtig: Nach jeder Änderung in der Konfiguration muss der Browser-Cache einmal gelöscht werden, da es ansonsten sein kann, dass der Browser falsche Daten im Speicher hat und Funktionalitäten von Squeeze nicht aufgerufen werden können

Squeeze-URL

Gibt die URL zu Squeeze an. Entspricht der URL über welche die normale Squeeze-Oberfläche aufgerufen werden kann (mit "http://" aber ohne "/main.php").

Squeeze-Api-Key

Ohne einen gültigen API-Key kann nicht auf Squeeze nicht zugegriffen werden. Ein API-Key kann über den Button "Neuen API-Key erzeugen" generiert werden, wenn URL, Login und Passwort angegeben wurden.

Squeeze-Login / Passwort

Benutzer und Passwort werden lediglich für die API-Key Generierung benötigt. Die Angaben werden nicht gespeichert und werden beim nächsten Öffnen der Konfiguration wieder leer angezeigt.

Mappentyp (x) und Feldname für Training (x)

Gibt ein Mapping an, welches Feld aus welchem Mappentypen für das Training verwendet werden soll. Die Angabe des Mappentyps entspricht dem technischen Namen in Documents. Der Feldname entspricht dem technischen Feldnamen in dem entsprechenden Mappentypen.

In der Standardauslieferung können die Angaben für zwei Mappentypen  vorgenommen werden. Für den Fall, dass es mehr als zwei Mappentypen gibt, welche mit Squeeze kommunizieren, kann die Anzahl an konfigurierbaren Mappentypen über die Eigenschaft "gadgetConfig" am Documents-Order ("SqueezeGeneralConfig" bzw. "Admin_Squeeze_Configuration") über den Eintrag "trainingFields" verändert werden.

image-1606224185838.png

Die maximale Anzahl der konfigurierbaren Mappings ist derzeit auf 20 begrenzt.

 

Funktionalitäten

Neuen API-Key erzeugen

Ein gültiger API-Key wird benötigt, damit die Squeeze-Konfigurationsoberflächen, sowie der Viewer angezeigt werden können. Damit ein neuer API-Key erzeugt werden kann, muss auf das Oberfläche zunächst eine gültige Squeeze-URL, ein Squeeze-Nutzer und und ein Passwort für diesen Nutzer angegeben werden:

image-1585315912039.png

Anschließend muss der Knopf "Neuen API-Key erzeugen" gedrückt werden. Wenn die Anmeldedaten korrekt sind, erscheint folgende Meldung:

image-1585316092138.png

Bei nicht erfolgreichen Meldung erscheint eine entsprechende Fehlermeldung.

Nach der Erstellung eines neuen API-Keys muss der Cache der Browsers einmal gelöscht werden!

Verbindung prüfen

Über den Knopf "Verbindung prüfen" kann die Verbindung nach Squeeze testet werden. Dafür wird eine gültige URL, sowie ein gültiger API-Key benötigt. Nutzername und Passwort sind für diese Funktionalität nicht notwendig.

Wenn der Test erfolgreich ist, erscheint folgende Meldung:

image-1585317417079.png

Wenn die Konfigurationsoberflächen von Squeeze nicht angezeigt werden können, aber der Verbindungstest erfolgreich ist, sollte der Cache des Browsers einmal gelöscht werden.