OneSpan Sign Cómo: Personalizar la ceremonia de firma

Haris Haidary, 9 de Marzo de 2016

Con OneSpan Sign, tiene la capacidad de personalizar varios aspectos de la ceremonia de firma para satisfacer las necesidades de su aplicación. Esto le permite integrar más fácilmente la experiencia de firma de eSignLive en su aplicación. En este blog, le mostraré cómo personalizar la ceremonia de firma con Java SDK, .NET SDK y REST API.

Configuración de nivel de paquete de documentos

Antes de entrar en el código, le daré una breve descripción de cada paquete disponible y la configuración de diseño de la ceremonia. Es importante tener en cuenta que no es necesario especificar ninguna de estas configuraciones. De forma predeterminada, tendrán los valores que se muestran a continuación si no se especifican. Configuración del paquete de documentos [id de tabla = 3 /] Configuración de diseño de ceremonia A continuación se muestra el diseño predeterminado de la ceremonia de firma de OneSpan Sign. Cada una de las secciones está etiquetada por conveniencia.  

Configuración del paquete de documentos

Nombre del ajuste Método de configuración del paquete de documentos Descripción
En persona withInPerson Si todos los documentos de un paquete deben firmarse en el mismo dispositivo.
withoutInPerson (predeterminado)
Optar por no withOptOut (predeterminado) Permita que un firmante no participe en la ceremonia de firma.
sinOptOut
Motivo de exclusión withOptOutReason Si un firmante decide optar por no participar, él / ella puede seleccionar una razón para su retiro.
Menú desplegable de idiomas withLanguageDropdown (predeterminado) Si se muestra el menú desplegable de idioma de la página de la ceremonia de firma.
sin idiomaDropdown
Propietario desplegable en persona hideOwnerInPersonDropdown Cuando se habilita en persona, decida si el paquete es propietario está presente en el menú desplegable del firmante.
showOwnerInPersonDropdown (predeterminado)
Primera declaración jurada disableFirstAffidavit Cuando se habilita en persona, decida si se muestra la primera página de declaración jurada al cambiar de firmantes desde el menú desplegable.
enableFirstAffidavit (predeterminado)
Segunda declaración jurada disableSecondAffidavit Cuando se habilita en persona, decida si se muestra la segunda página de declaración jurada al cambiar de firmantes desde el menú desplegable.
enableSecondAffidavit (predeterminado)
Disminución con declinación Si un firmante puede rechazar el paquete de documentos.
sin rechazo (predeterminado)
Filigrana withWatermark (predeterminado) Si los documentos firmados están sellados con el logotipo de OneSpan Sign con cada firma.
sin marca de agua
Capturar texto withCaptureText Si los documentos firmados se sellan con la fecha, la hora y el nombre del firmante en cada ubicación donde se firmaron.
withoutCaptureText (predeterminado)
Enlace de entrega withHandOverLinkHref Reemplaza el botón Continuar en la ceremonia de firma. El usuario será redirigido a una URL que especifique.
withHandOverLinkText El texto que aparecerá en el botón de transferencia.
withHandOverLinkTooltip El texto que aparecerá al pasar el mouse sobre el botón de transferencia.
Botón de descarga withDocumentToolbarDOwnloadButton (predeterminado) Si el botón de descarga está disponible.
withoutDocumentToolbarDownloadButton
Diálogo al completar withoutDialogOnComplete (predeterminado)
withDialogOnComplete Si el diálogo de finalización, que pregunta a los firmantes si desean revisar los documentos o abandonar el sistema, se muestra después de la firma.

Configuración de diseño de ceremonia

A continuación se muestra el diseño predeterminado de la ceremonia de firma de OneSpan Sign. Cada una de las secciones está etiquetada por conveniencia.

esl_overview

Nombre del ajuste Método de configuración de diseño de ceremonia Descripción
Navegador withNavigator (predeterminado) Mostrar el navegador. Dirige al firmante a la siguiente firma disponible.
sin navegador
Navegación global withGlobalNavigation (predeterminado) Mostrar la navegación global.
sin navegación global
Migas de pan withBreadCrumbs (predeterminado) Muestra las migas de pan.
sin pan rallado
Barra de sesión withSessionBar (predeterminado) Mostrar la barra de sesión.
withoutSessionBar
Título withTitle (predeterminado) Muestra el título
sin título
Barra de progreso withProgressBar (predeterminado) Mostrar la barra de progreso.
sin barra de progreso
IFrame withIFrame Si la ceremonia de firma está incrustada en un iFrame.
sin marco (predeterminado)
Logo withLogoSource Reemplaza el logotipo predeterminado de OneSpan Sign por un logotipo personalizado. Una URL válida para el logotipo personalizado debe pasarse como argumento.
Botón de confirmación global withGlobalConfirmButton (predeterminado) Mostrar el botón de confirmación en el área de acciones globales.
sin botón global de confirmación
Botón de descarga withGlobalDownloadButton (predeterminado) Mostrar el botón de descarga en el área de acciones globales.
sin botón global de descarga
Botón Guardar como diseño withGlobalSaveAsLayoutButton (predeterminado) Muestre el botón "Guardar como diseño" en el área de acciones globales.
sinGlobalSaveAsLayoutButton

El código

Como mencioné anteriormente, le mostraré cómo personalizar la ceremonia de firma con Java SDK, .NET SDK y REST API. Continúe y pase a la sección que se aplica a su método. Cubriré la misma información en cada segmento. El código completo de este blog se puede encontrar en el código compartido de la comunidad de desarrolladores: Java , .RED y DESCANSO .

Comunidad de desarrolladores de OneSpan Sign

Comunidad de desarrolladores de OneSpan Sign

¡Únase a la comunidad de desarrolladores de OneSpan Sign! Foros, blogs, documentación, descargas de SDK y más.

Únete hoy

SDK de Java

Comenzaré con el SDK de Java. El siguiente código de muestra muestra cómo editar el bloque de configuración. Si necesita una comparación con la creación básica de objetos de documento o si esta es la primera vez que crea un paquete con el SDK de Java, consulte esto anterior Blog .

.withSettings (DocumentPackageSettingsBuilder.newDocumentPackageSettings ()
			.withInPerson ()
			.withOptOut ()
			.withOptOutReason ("Términos de rechazo")
			.withoutLanguageDropDown ()
			.hideOwnerInPersonDropDown ()
			.disableFirstAffidavit ()
			.disableSecondAffidavit ()
			.withDecline ()
			.withoutWatermark ()
			.withCaptureText ()
			.withHandOverLinkHref ("http://www.google.com")
			.withHandOverLinkText ("Salir al sitio")
			.withHandOverLinkTooltip ("Serás redirigido a la página de inicio de Google")
			.withDocumentToolbarDownloadButton ()
			.withDialogOnComplete ()							
.withCeremonyLayoutSettings (CeremonyLayoutSettingsBuilder.newCeremonyLayoutSettings ()
				.withNavigator ()
				.withoutGlobalNavigation ()
				.withoutBreadCrumbs ()
				.withSessionBar ()
				.withTitle ()
				.withProgressBar ()
				.withIFrame ()
				.withGlobalConfirmButton ()
				.withoutGlobalDownloadButton ()
				.withoutGlobalSaveAsLayoutButton ()
				.withLogoSource ("http://www.logo-maker.net/images/common/company-logo8.gif")))

.NET SDK

A continuación, cubriré el SDK de .NET. El siguiente código de muestra muestra cómo editar el bloque de configuración. Si necesita una comparación con la creación básica de objetos de documento o si es la primera vez que crea un paquete con el SDK de .NET, consulte esto anteriormente Blog .

.WithSettings (DocumentPackageSettingsBuilder.NewDocumentPackageSettings ()
                        .WithInPerson ()
                        .WithOptOut ()
                        .WithOptOutReason ("Términos de rechazo")
                        .WithoutLanguageDropDown ()
                        HideOwnerInPersonDropDown ()
                        .DisableFirstAffidavit ()
                        .DisableSecondAffidavit ()
                        .WithDecline ()
                        .WithoutWatermark ()
                        .WithCaptureText ()
                        .WithHandOverLinkHref ("http://www.google.com")
                        .WithHandOverLinkText ("Salir al sitio")
 			.WithHandOverLinkTooltip ("Redirigirá a la página de inicio de Google")
                        .WithoutDocumentToolbarDownloadButton ()
                        .WithoutDialogOnComplete ()
              .WithCeremonyLayoutSettings (CeremonyLayoutSettingsBuilder.NewCeremonyLayoutSettings ()
                                .ConNavigator ()
                                .SinGlobalNavigation ()
                                .WithoutBreadCrumbs ()
                                .WithSessionBar ()
                                .WithTitle ()
                                .WithProgressBar ()
                                . WithIFrame ()
                                .WithGlobalConfirmButton ()
                                .WithoutGlobalDownloadButton ()
                                .WithoutGlobalSaveAsLayoutButton ()
                                .WithLogoImageSource ("http://www.logo-maker.net/images/common/company-logo8.gif")))

API REST

Finalmente, cubriré la API REST. El ejemplo de JSON a continuación muestra cómo editar el objeto de configuración. Incluí que creará un nuevo paquete de documentos con configuraciones de ejemplo para mayor comodidad. Si necesita una comparación con la creación básica de objetos de documento o si es la primera vez que crea un paquete con la API REST, consulte esto anteriormente Blog .

{
  "configuración": {
    "ceremonia": {
      "eventos": {
        "completo": {
          "diálogo": verdadero,
          "redirigir": ""
        }
      },
      "inPerson": cierto,
      "decliveButton": cierto,
      "declinarReasons": [],
      "disableDeclineOther": falso,
      "disableDownloadForUncompletedPackage": falso,
      "disableFirstInPersonAffidavit": verdadero,
      "disableInPersonAffidavit": falso,
      "disableOptOutOther": falso,
      "disableSecondInPersonAffidavit": verdadero,
      "documentToolbarOptions": {
        "downloadButton": verdadero
      },
      "entregar": {
        "title": "Serás redirigido a la página de inicio de Google",
        "href": "http://www.google.com",
        "text": "Salir al sitio"
      },
      "hideCaptureText": falso,
      "hideLanguageDropdown": verdadero,
      "hidePackageOwnerInPerson": verdadero,
      "hideWatermark": verdadero,
      "maxAuthFailsAllowed": 3,
      "optOutButton": verdadero,
      "optOutReasons": [
        "Rechazar términos".
      ],
      "estilo": nulo,
      "diseño": {
        "pie de página": {},
        "iframe": cierto,
        "navegador": verdadero,
        "brandingBar": {
          "logotipo": {
            "src": "/sites/default/files/blog/images/company-logo8.gif",
            "enlace": ""
          }
        },
        "encabezado": {
          "feedback": verdadero,
          "globalActions": {
            "confirmar": verdadero,
            "descargar": falso,
            "hideEvidenceSummary": falso,
            "saveAsLayout": falso
          },
          "barra de título": {
            "título": verdadero,
            "progressBar": verdadero
          },
          "migas de pan": falso,
          "globalNavigation": falso,
          "sessionBar": verdadero
        }
      }
    }
  },
  "type": "PAQUETE",
  "status": "BORRADOR",
  "nombre": "Personalización de la ceremonia de firma"
}

Ejecutando su código

Ahora puede seguir adelante y ejecutar su código. Dependiendo de la configuración que elija, su resultado final puede ser diferente al mío. Si siguió mi ejemplo, a continuación hay una captura de pantalla de lo que podría esperar:

resultados

Ahí tienes. Has personalizado con éxito la ceremonia de firma.

Si tiene preguntas sobre este blog o cualquier otra cosa relacionada con la integración de OneSpan Sign en su aplicación, visite los foros de la comunidad de desarrolladores:

https://developer.onespan.com . Eso es todo de mi parte. ¡Gracias por leer! Si esta publicación le parece útil, compártala en Facebook, Twitter o LinkedIn.

Haris Haidary
Evangelista Técnico Junior
LinkedIn El | Gorjeo