Extend signing application (OnPremise only)


WebSign is exposing custom events that allows integrators to extend or change the built-in functionality of the application. The following client side events are supported :

  • DocumentsLoaded : event is triggered when all document images are loaded and the user can fully interact with the documents.

  • NavigateToNextElement : event is triggered when the user navigates to the next element using the "Next" UI button. The argument for this event is the DOM id of the element to which the guide navigated to.

  • Signed : event triggered after user signs a signature field. The argument for this event is the DOM id of the signature field which was just signed.

  • BatchSigned : event triggered after user batch signs. The argument for this event is signature type of the signature field which was just signed.

  • Finishing : event triggered just before the user will manually finish the signing process.

To enable triggering these custom events :

  • feature "EnableTriggerCustomEvents" should be enabled in Bulksign settings file.

  • we ship a sample JavaScript file that hooks up to all custom events , find "CustomEventsHandler.js" in \Scripts\CustomEventsHandler.js

  • extend the code to fit your needs :


$(document).on('DocumentsLoaded', function (name, parameters) {

    console.log(name.type);

});


$(document).on('NavigateToNextElement', function (name, parameters) {
    console.log(name.type);

    if (parameters !== undefined) {
        console.log(parameters);
    }
});


$(document).on('Signed', function (name, parameters) {
    console.log(name.type);

    if (parameters !== undefined) {
        console.log(parameters);
    }
});


$(document).on('Finishing', function (name, parameters) {

    console.log(name.type);

});
Info

For LocalCertificate signatures , the "BatchSigned" event is never raised even when signing in batch mode. Due to the way LocalCertificate signing works, the "Signed" event is raised for each LocalCertificate signature type instead.