CIB doXiview - Integration: Das sign Interface

CIB doXiview - Integration

Die Kommunikationsschnittstellen

Das sign Interface

Allgemein
signatureInfo
signatureSelected
documentToSign
loadSignedDocument
UpdateSignedDocument
setSignatureEditingAllowed

Allgemein

Das Interface sign enthält Funktionen für das Hinzufügen von elektronischen Unterschriften zu PDF-Dokumenten.

Es ist aus Sicht des Masters in Form des Objekts CibSignMasterFunctions verfügbar.

CIB doXiview ist in der Lage, Felder für elektronische Unterschriften in PDF Dokumenten optisch hervorzuheben und diese für den Benutzer per Doppelklick auswählbar zu machen.

Der eigentliche Vorgang des Signierens wird von der Master-Anwendung übernommen und die neue Dokument-Version anschließend in der bestehenden Sitzung erneut angezeigt.

Als Voraussetzung sind zum Freischalten der signaturrelevanten Funktionalität die folgenden Startparameter an CIB doXiview zu übergeben:

var startParameters = {
webview: {
               digSigEnabled: Freischalten der Signatur-Funktionalität
               uploadSignContent: Wenn Jview-Dateien (von CIB webDesk) unterschrieben werden 
                        sollen.
   }
}

signatureInfo

Diese Funktion wird lediglich für das Hinzufügen von elektronischen Unterschriften zu einem PDF Dokument benötigt.

Wenn ein Dokument geladen wurde, teilt CIB doXiview dem Master über diese Funktion alle im Dokument vorhandenen Unterschriftenfelder mit.

Function

Parameters

Return

signatureInfo

signatureList: JSON

void

Notifies the Master of CIB doXiview about all signatures contained in the currently loaded document after it is finished loading.

Parameter description:

JSON: signatureList:

A JSON representation of a list of signatures contained in the currently loaded document with the following structure:

        var signatureList = [
                  signature: signature information,
                  ...
          ]

where each signature contains the following information:

        var signature = {
                  name: The unique field name
                  info: Additional information to the signature
                  isRequired: Whether or not the signature is required
                  isSigned: Whether or not the signature was already signed
                  signatureLocation: the information to identify the signature in
                             the loaded document
          }

where the signatureLocation is defined as follows:

        var signatureLocation = {
                  receiverCopyName: entry exists only if receiver copy name exists
                  pageNumber: the page Number
                  topLeftX: the top left x coordinate of the signatures bounding box
                  topLeftY: the top left y coordinate of the signatures bounding box
                  width: the width of the signatures bounding box
                  height: the height of the signatures bounding box
          }

Registration by master:

master.sign.registerSignatureInfoCallback(callback: FunctionCallback);

Hinweis: In der Testoberfläche kann die Benachrichtigung durch CIB doXiview wie folgt beobachtet werden:

Öffnen Sie CIB doXiview im Modus Sign (Pdf)
In der Konsole können Sie die übergebenen Informationen einsehen, nachdem das Dokument geladen wurde:

signatureSelected

Diese Funktion wird lediglich für das Hinzufügen von elektronischen Unterschriften zu einem PDF Dokument benötigt.

Wenn der Benutzer einen Doppelklick auf einem Unterschriftenfeld ausführt, soll dieses mit einer Unterschrift gefüllt werden. Da das eigentliche Signieren die Aufgabe des Masters ist, wird dieser mittels signatureSelected darüber informiert, dass und in welchem Feld unterschrieben werden soll. Diese Funktion wird lediglich für das Hinzufügen von elektronischen Unterschriften zu einem PDF Dokument benötigt.

Function

Parameters

Return

signatureSelected

signature: JSON

void

Notifies the integrator of CIB doXiview when a signature was double clicked by a user.

Parameter description:

JSON: signature:

A JSON representation of the selected signature defined as follows:

       var signature = {
                  name: The unique field name
                  signatureLocation: the information to identify the signature in
                                     the loaded document

where the signatureLocation is defined as follows:

        var signatureLocation = {
                  receiverCopyName: entry exists only if receiver copy name exists
                  pageNumber: the page Number
                  topLeftX: the top left x coordinate of the signatures bounding box
                  topLeftY: the top left y coordinate of the signatures bounding box
                  width: the width of the signatures bounding box
                  height: the height of the signatures bounding box
          }

Registration by master:

master.sign.registerSignatureSelectedCallback(callback: FunctionCallback);

Hinweis: In der Testoberfläche kann dieser Aufruf wie folgt nachvollzogen werden:

Öffnen Sie CIB doXiview im Modus Sign (Pdf)

Doppelklicken Sie auf ein Unterschriftenfeld

In der Konsole können Sie die übergebenen Informationen einsehen:

documentToSign

Diese Funktion wird lediglich für das Hinzufügen von elektronischen Unterschriften zu einem PDF Dokument benötigt - auch nur dann, wenn es sich bei dem Dokument um eine .jview-Datei handelt, d.h. das Dokument aus CIB webDesk / CIB darkDesk stammt.

Im Falle von .jview-Dateien findet ein zusätzlicher Funktionsaufruf von CIB doXiview an den Master statt. CIB doXiview legt das Dokument in der Komponente webstore ab und informiert den Master, unter welcher webstoreId es dort aufzufinden ist. Dieser kann es dann bei Bedarf aus dem webstore herunterladen und signieren.

Function	Parameters	Return
documentToSign	webstoreId: String	void
Notifies the integrator of CIB doXiview about the signable content which was extracted from a jview file and uploaded to the configured webstore. Parameter description: String: webstoreId: The webstore id for accessing the signable document content.
Registration by master: master.sign.registerDocumentToSignCallback(callback: FunctionCallback);

Hinweis: In der Testoberfläche kann dieser Aufruf wie folgt nachvollzogen werden:

Öffnen Sie CIB doXiview im Modus Sign (Jview)
In der Konsole wird angezeigt, unter welcher webstoreId CIB doXiview das Dokument abgelegt hat.

loadSignedDocument

Diese Funktion wird lediglich für das Hinzufügen von elektronischen Unterschriften zu einem PDF Dokument benötigt.

Nachdem eine neue Signatur auf dem Dokument aufgebracht und die neue Dokument-Version vom Master im webstore abgelegt wurde, teilt der Master CIB doXiview mittels loadSignedDocument mit, unter welcher webstoreId CIB doXiview die neue Version des Dokumentes laden soll.

Function

Parameters

Return

loadSignedDocument

webstoreId: String 
signatureLocation: JSON

Void

Notifies CIB doXiview that the specified document shall be loaded into the existing viewer session. It is also possible to specify a signature to which shall be scrolled after the document is processed.

Parameter description:

String: webstoreId:

The webstore id to the new document version to be loaded.

JSON: signatureLocation:

A JSON representation of the information to identify the signature in the loaded document, defined as follows:

       var signatureLocation = {
                  pageNumber: the page Number
                  topLeftX: the top left x coordinate of the signatures bounding box
                  topLeftY: the top left y coordinate of the signatures bounding box
                  width: the width of the signatures bounding box
                  height: the height of the signatures bounding box
          }

Registration by slave:

slave.sign.registerLoadSignedDocumentCallback(callback: FunctionCallback);

UpdateSignedDocument

Analog zu der loadSignedDocument Funktion kann im Falle für .jview-Dateien die neue Dokumentversion mit dem folgenden Aufruf propagiert werden.

Function

Parameters

Return

updateSignedDocument

webstoreId: String 
signatureLocation: JSON

Void

Notifies CIB doXiview that the specified document shall be updated into the existing viewer session. It is also possible to specify a signature to which shall be scrolled after the document is processed. This method is especially used for updating the document within jview file content in the CIB doXiview server cache.

Parameter description:

String: webstoreId:

The webstore id to the new document version to be loaded.

JSON: signatureLocation:

A JSON representation of the information to identify the signature in the loaded document, defined as follows:

        var signatureLocation = {
                  pageNumber: the page Number
                  topLeftX: the top left x coordinate of the signatures bounding box
                  topLeftY: the top left y coordinate of the signatures bounding box
                  width: the width of the signatures bounding box
                  height: the height of the signatures bounding box
          }

Registration by slave:

slave.sign.registerUpdateSignedDocumentCallback(callback: FunctionCallback);

setSignatureEditingAllowed

Diese Funktion wird lediglich für das Hinzufügen von elektronischen Unterschriften zu einem PDF Dokument benötigt.

Der Master kann zur Laufzeit über die Funktion setSignatureEditingAllowed bestimmen, ob das Dokument generell unterschreibbar sein soll.

Function

Parameters

Return

setSignatureEditingAllowed

signatureEditingAllowed: boolean

Void

Notifies CIB doXiview whether or not signature editing shall be allowed.

Parameter description:

boolean: signatureEditingAllowed

Whether or not signature editing shall be allowed.

Registration by slave:

slave.sign.registerSetSignureEditingAllowedCallback(callback: FunctionCallback);