CIB doXiview technischer Leitfaden

Erste Schritte bei der Verwendung von CIB doXisign in CIB doXiview

Um Dokumente innerhalb von CIB doXiview zu signieren, gibt es verschiedene Möglichkeiten. Wenn Sie das Modul CIB doXisign zum Signieren nutzen möchten gehen Sie bitte wie folgt vor:

1) Deployment und Konfiguration von „CIB doXisign“

Die .war Datei von CIB doXisign kann in einem beliebigen Applicationserver deployt werden.
Für diesen Schritt sei zusätzlich auf die Schnellstart-Dokumentation von CIB doXisign verwiesen.

 

2) Konfiguration von „CIB doXiview“

Nachdem CIB doXisign deployt wurde, muss in der Konfiguration von CIB doXiview hinterlegt werden, wo der Service zu erreichen ist. Dies geschieht über Konfigurationseinstellungen in der folgenden Datei:
     doxiview/WEB-INF/classes/environment-config.properties
Die Konfigurationseinstellung muss aus Sicht des doXiview Servers eingetragen werden.
     sign.url=http://localhost:8080/doxisign

 

3) Integration von CIB doXiview über CIB iwc.

Die Integration von CIB doXiview durch die Kundenanwendung über CIB iwc wie in Abschnitt CIB doXiview technischer Leitfaden beschrieben, ist Voraussetzung, wenn die Funktion vollumfänglich genutzt werden soll. Beim Öffnen des Viewers wird CIB doXiview über die JavaScript-Schnittstelle nach Startparametern fragen.

Die von CIB doXiview angeforderten Startparameter müssen als JSON-Objekt der folgenden Struktur  entsprechen:

var startParameters = {
            "loginContext": {
                  "userId": "test-userId",
            },
            "doxiview": {
                   "uistyle": "cib",
                   "ui": "form",
                   "signMode": "internal",
                   "signProcessId": "some-existing-sign-process-id",
"signatureToken": "user-specific-token",
"useUniqueCache": "true",
"documentVersionUpdateMode": "webstore",
                   "repo_alias": "http-repository",
                   "urlField": "http://localhost:8080/signable.pdf",
                   "ext": "pdf"
            }
};

 

Wichtig sind hier vor allem die folgenden Startparameter:

Startparameter

Wert

loginContext.userId

Informationen über den Benutzer, wie dessen Nutzername. Dieser kann für den Audit-Trail von Bedeutung sein.

signMode

Eine von den folgenden Möglichkeiten:

-         internal: Nutzung von CIB doXisign

-         external: Der Signaturprozess geschieht außerhalb von CIB doXiview

-         disabled: Es darf nicht signiert werden.

signatureToken

Ein maximal 32 Zeichen langes text-Token, welches an CIB doXisign zum Einmischen einer Unterschrift mitgegeben wird und zusätzlich zu dem Bild der Signatur im Dokument erscheinen wird.

signProcessId

Eine eindeutige ID zur Identifikation eines laufenden dokumentbasierten Signaturprozesses. Diese ID ist nur dann anzugeben, wenn ein bestehender Signatur-Prozess fortgesetzt werden soll.

 

CIB doXiview informiert seinen Integrator nach jeder geleisteten Unterschrift, über den aktuellen Status des Signaturprozesses.

Dafür muss ein IWC Callback wie folgt registriert werden:

$wnd.iwc.master.registerFunction("onSignatureFieldSigned", function(params) {
      console.log("received data: " + JSON.stringify(params))
      // react on the incoming data
}, false);


Das Resultat sieht dann beispielhaft wie folgt aus:

{       
        "processId": "36a84fef-ded9-41e8-952f-4d11cc60658b",
        "remainingSignatures": "0",
        "totalSignatures": "2",
        "signature": {
               "name": "Unterschrift2",
               "info": "SecondSignature",
               "isRequired": false,
               "isSigned": false,
               "signatureLocation": {
                       "pageNumber": 1,
                       "topLeftX": 147,
                       "topLeftY": 789,
                       "width": 520,
                       "height": 118                }
        }
}


Die Prozess-ID kann im weiteren Verlauf, z.B. dafür genutzt werden, um sich das Signaturverlaufsprotokoll zu dem Dokument abzuholen oder um bereits gestartete Signaturprozesse zu einem späteren Zeitpunkt wieder aufzunehmen.

Für Detailinformationen zu diesem Ablauf sei auf die Dokumentation CIB doXisign – Schnellstart verwiesen.