CIB doXiview - Integration

Möglichkeiten der Clientseitigen Integration von CIB doxiView

Es gibt prinzipiell 3 Möglichkeiten, wie CIB doXiview in einem Web-Browser geöffnet werden kann:

  1. Aufruf von CIB doXiview durch Eingabe einer URL in die Adresszeile des Web-Browsers
  2. Integration von CIB doXiview in eine andere Webapplikation über eine URL
  3. Integration von CIB doXiview in eine andere Webapplikation über eine URL und CIB iwc

Diese Möglichkeiten werden im Folgenden kurz skizziert.

Aufruf von CIB doXiview durch Eingabe einer URL in der Adress-Zeile des Web-Browsers
Aufruf von CIB doXiview über eine URL aus einer anderen Webapplikation
Integration von CIB doXiview über CIB iwc


Aufruf von CIB doXiview durch Eingabe einer URL in der Adress-Zeile des Web-Browsers

CIB doXiview ist eine Webapplikation, welche im einfachsten Fall direkt über die Eingabe einer geeigneten URL in der Browser-Adresszeile geladen und angezeigt werden kann. In diesem Fall gibt der Benutzer direkt als Teil der URL ein, welches Dokument von CIB doXiview unmittelbar angezeigt wird. Die Anzeige nimmt anschließend vollständig einen Browser-Tab ein.

Beispiele:

  1. Aufruf von CIB doXiview und Anzeige eines spezifizierten Dokuments
    Durch Eingabe der folgenden URL in der Adresszeile des Browsers wird CIB doXiview geöffnet und zeigt das Dokument example.pdf an:
    http://myserver/webview/?rsp=false&iwc_mode=standalone&urlField=http://myotherserver/example.pdf&ext=pdf
  2. Aufruf von CIB doXiview ohne Dokument mit einem Upload-Button
    Durch Eingabe der nächsten URL in der Adresszeile des Browsers wird CIB doXiview zunächst ohne ein Dokument geöffnet. Der Benutzer kann anschließend per Schaltfläche in der CIB doXiview Toolbar ein Dokument aus dem lokalen Dateisystem auswählen und in CIB doXiview hochladen und anzeigen.
    http://myserver/webview/?rsp=false&uistyle=cib&iwc_mode=standalone&ui=upload


Starten Sie die Demoversion von CIB doXiview und geben die folgende URL im Web-Browser ein:

http://localhost:8080/webview/?rsp=false&iwc_mode=standalone&ui=upload


Aufruf von CIB doXiview über eine URL aus einer anderen Webapplikation

In den meisten Fällen soll CIB doXiview jedoch aus folgenden Gründen in eine andere Webapplikation, d.h. eine andere HTML-Seite, eingebettet werden:

  1. Die einbettende Webapplikation bestimmt über Aufrufparameter, welches Dokument CIB doXiview anzeigen soll.
  2. Die CIB doXiview-Oberfläche soll optisch in der Seite der einbettenden Webapplikation integriert werden, d.h. in einem <iframe> HTML-Tag. Die weiter oben genannten Beispiel-URLs können in dem Fall unverändert als Wert für das src-Attribut eingesetzt werden.

Die folgende Datei simple-iframe.html aus der CIB doXiview Demoversion integriert CIB doXiview mittels <iframe>-Tag. Diese kann dort aufgerufen werden wie folgt:

http://localhost:8080/doxiview-examples/simple-iframe.html


Alternativ könnte mit einem Anchor Tag <a> und dem href-Attribut CIB doXiview in einem neuen Browser-Tab geöffnet werden.

Die Datei beispiele.html aus der CIB doXiview Demoversion enthält einen Link auf CIB doXiview als <a>-Tag.

Die einbettende Webapplikation kann CIB doXiview auf diese Weise parametrisiert aufrufen, hat allerdings ab diesem Zeitpunkt keine Möglichkeit mehr, mit CIB doXiview innerhalb des Webbrowsers zu kommunizieren.


Integration von CIB doXiview über CIB iwc

Für die folgenden Anwendungsfälle wird eine engere Kopplung zwischen der einbettenden Webapplikation und CIB doXiview benötigt:

  • Integration von eigenen Schaltflächen in die Toolbar von CIB doXiview und anschließende Reaktion, wenn der Benutzer diese anklickt
  • Anzeigen von eigenen Hinweistexten an den Benutzer
  • Sperren und Entsperren der Benutzeroberfläche von CIB doXiview
  • Drucken in Originalqualität über einen Dienst außerhalb des Webbrowsers
  • Anbindung von CIB doXiview an ein Archivsystem
  • Editieren von Freitextbereichen in RTF-Dokumenten
  • Ausfüllen von Unterschriftenfeldern

In diesen Fällen wird CIB doXiview nicht nur initial von der einbettenden Webanwendung aufgerufen, sondern kommuniziert auch anschließend mit ihr.

Zunächst wird wie im vorherigen Abschnitt Aufruf von CIB doXiview über eine URL aus einer anderen Webapplikation
beschrieben, CIB doXiview wieder mit einem <iframe> HTML-Tag in  die einbettende Anwendung integriert. Die Verwendung eines <iframe> wird bei dieser Integrationsart nun zwingend vorausgesetzt.

Im Unterschied zu Aufruf von CIB doXiview über eine URL aus einer anderen Webapplikation
wird hier als URL des iframe src-Attributes nur eine Basis-URL auf CIB doXiview angegeben:

<iframe src="http://myserver/webview/index.jsp?iwc_mode=internal"/>

Diese Basis-URL enthält nur den Parameter

iwc_mode=internal

Damit wird CIB doXiview signalisiert, dass weitere Parameter auf anderem Wege, nämlich mittels JavaScript-Funktionen übermittelt werden.

Das folgende Kapitel Kommunikation über CIB iwc erläutert die Integration über CIB iwc im Detail.