SQUEEZE Developer Handbuch

Leitfaden für die Anbindung und Integration von Squeeze in Drittsystemen.

• SQUEEZE Viewer Interaktionen
• Post-Messages
• Receive-Messages
• SQUEEZE SOAP
• Anbindung SOAP
• SQUEEZE Frontend einbetten
• Einbettung des Frontends

SQUEEZE Viewer Interaktionen

Mit Post-Message und Receive-Message können Daten aus dem Viewer verarbeitet werden.

Post-Messages

getRawDocument - Gibt das gesamte Dokument zurück (über Receive-Message-Antwort)

getSelectedArea - Gibt die markierten Bereiche im Viewer zurück (über Receive-Message-Antwort)

.message:  markLineCell - Markiert eine Positionszeile im Viewer

.messag: toggleTrainingDisplayState - Zeigt den Viewer an

 

Receive-Messages

sqzViewerLoaded - Wird aufgerufen sobald der 

message: RawDocument - Gibt das gesamte xDoc-Objekt zurück

message: SelectedArea - Gibt die markierte Stellen zurück

 

Zudem gibt es noch eine Rückgabe in der das Objekt "words" enthalten ist

SQUEEZE SOAP

Alles zum SQUEEZE Soap Server. Dieser orientiert sich an der DOCUMENTS.wsdl von otris Documents.

Anbindung SOAP

URL

Um den SOAP Server per Request zu erreichen, muss die  URL den folgende Aufbau enthalten.

http(s)://<MANDANT/SERVERNAME>:<PORT>/api/soapserver.php

Nur dann kann der Request auch den SOAP Server der SQUEEZE Installation erreichen.

Login

Beim Senden eines Request muss eine Session ID angegeben werden.
Sollte diese Session noch nicht existieren, muss eine erstellt werden.

Dafür kann der Login Endpunkt/Request genutzt werden.

Dabei muss ein User angegeben werden, der in SQUEEZE existiert.
Der im Request anzugebende Mandant ist nicht wichtig, da dieser aus der URL gezogen wird.
Ebenfalls das Attribut Code ist zu vernachlässigen.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:doc="http://xml.otris.de/ws/DOCUMENTS.xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <doc:login>
         <user>yourUserName</user>
         <principal>ThisIsNotNeeded</principal>
         <passwd>yourVerySecretPassword</passwd>
         <code></code>
         <locale>de</locale>
      </doc:login>
   </soapenv:Body>
</soapenv:Envelope>

 

SQUEEZE Frontend einbetten

Wie man das Squeeze Frontend in eine andere Anwendung einbettet.

Einbettung des Frontends

Das Frontend kann über ein HTML iframe-Element eingebettet werden. Dies erfolgt nach dem folgenden Schema:

<iframe 
	id="Frontend"
	class="frontend-iframe"
	allow="clipboard-read; clipboard-write"
	style="width:100%; height: 100%"
	src="http://<SQZ URL>/ui/index.html?apiKey=<APIKEY>&lang=<LANGUAGE>&page=/app/squeeze/<PAGE>&parameter=<PARAMETER>"
></iframe>

Squeeze URL	Die URL zur Squeeze Installation
API-Key	Kann aus dem Frontend abgerufen werden (unter 'Meine API Keys' in den Benutzereinstellungen)
Language	Wenn erforderlich, kann über den Parameter 'lang' eine Sprache angegeben werden.   Mögliche Werte: "de", "en", "pl", "it", "nl", "dk", "fr", "es", "us", "ch" Die jeweilige Sprache muss im Frontend aktiviert sein, außer "de" und "en", da diese zum Standard gehören.
Page	Die Angabe der jeweiligen Seite erfolgt über den URL-Pfad wie im Frontend. Als Basis muss immer /app angeben werden.   Beispiel: /app/squeeze/embeddableReports
Parameter	(Optionale) seitenabhängige Parameter.    Folgende Parameter stehen aktuell zur Auswahl für folgende URL-Pfade: Page Parameter /app/squeeze/embeddableReports showReportAutovalidation Anzeige des Autovalidation-Reports showReportFieldSelectionQuality Anzeige des Felderauslesequalität-Reports Das Feature Flag reportValidatedDocuments muss aktiviert sein. /app/squeeze/reports -

Demo Integration für das Squeeze Frontend (V2)

Dies kann auch getestet werden mittels der Datei im Squeeze Frontend Git-Projekt.
Der Pfad zu der Datei: /public/integration/index.html