CIB doXiview - Integration

Die Kommunikationsschnittstellen

Erklärung zur SchnittstellenBeschreibung

Die Verwendung einer Funktion zur Kommunikation setzt voraus, dass

  • der eine Kommunikationsteilnehmer die Funktion für den anderen bereitstellt, und
  • der andere Kommunikationsteilnehmer die Funktion aufruft.

Um die jeweilige Seite der Kommunikation deutlich zu machen, besteht eine Namenskonvention.

Der Bereitsteller einer Funktion namens someFunction ruft zu diesem Zweck eine Funktion auf, die per Konvention registerSomeFunctionCallback genannt wird.

Der Aufrufer kann diese Funktion anschließend aufrufen, per Konvention unter dem Namen someFunction.

Die Benennung dieser Funktionen hängt also nicht von der generellen Rolle einer Anwendung als Master oder Slave ab, sondern von der Richtung der Kommunikation bezogen auf eine einzelne Funktion.

Beispiel: Es gibt eine Funktion, welche CIB doXiview in Richtung seines Masters aufruft, um Startparameter zu erhalten.

Da in diesem Fall der Master die Funktion bereitzustellen hat, ruft er zu diesem Zweck die in seiner Schnittstelle CibMasterCommonFunctions  definierte Funktion mit Namen registerStartParametersCallback auf. Als Parameter übergibt er die vom Slave aufrufbare Funktion:

var getStartParameters = function(…
registerStartParameterCallback(getStartParameters)

Als Aufrufer dieser Funktion ist der Slave vorgesehen. Er ruft dazu die in seiner Schnittstelle CibSlaveCommonFunctions vorhandene Funktion getStartParameters auf:

var resultCallback = { success: function…
getStartParameters(resultCallback)


In den Funktionsbeschreibungen in diesem Kapitel ist im untersten Abschnitt Registration definiert, ob entweder der Master oder der Slave die definierte Funktion registrieren muss. Die jeweils andere Seite kann die Funktion mit dem Namen aufrufen, welcher links oben unter Function genannt ist.

Jede Funktionsbeschreibung ist aus Sicht der aufrufenden Seite formuliert.

Ihre Anwendung, in welche CIB doXiview integriert wird, ist immer der Master.

Function

Parameters

Return

getStartParameters

callback: ResultCallback

JSON

Returns CIB doXiview start parameters required for viewing a document in CIB doXiview. The result will be returned through the success-method of the specified result callback.

Return:

A JSON representation of start parameters which has the following structure:

var startParameters = {
          context : {login context},
          webview : {
               // doxiview specific start parameters
},         webedit : {
// webEdit specific start parameters
} }

Registration by master:

master.common.registerStartParameterCallback(callback: FunctionCallback);

 

Beispiel-Implementierung aus Sicht Master (integrierende Anwendung):

master.common.registerStartParameterCallback(function() {
var startParameters = {
                "webview": {
                         "uistyle":"cib",                          "ui":"upload",                 }
        };
        return startParameters;
});