Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

La Signer Experience de OneSpan Sign se puede personalizar. Al personalizar la Signer Experience, puede integrar a la perfección el proceso de firma en su propio sitio.

Configuración del paquete de documentos

La siguiente tabla proporciona una breve descripción de los ajustes de la Signer Experience que pueden personalizarse. Tenga en cuenta que no es obligatorio especificar ninguno de estos ajustes. Si no se define un ajuste, se utilizarán los valores predeterminados que se muestran a continuación.

Nombre del ajuste Método de configuración del paquete de documentos Descripción
En persona withInPerson Define si todos los documentos de un paquete deben firmarse en el mismo dispositivo.
withoutInPerson (predeterminado)
Propietario en desplegable En persona hideOwnerInPersonDropdown Cuando la opción En persona está activada, define si el propietario del paquete está presente en el menú desplegable de firmantes.
showOwnerInPersonDropdown (predeterminado)
Primera declaración jurada disableFirstAffidavit Cuando la opción En persona está activada, define si se muestra la primera página de la declaración jurada al cambiar de firmante en el menú desplegable de firmantes.
enableFirstAffidavit (predeterminado)
Segunda declaración jurada disableSecondAffidavit Cuando la opción En persona está activada, define si se muestra la segunda página de la declaración jurada al cambiar de firmante en el menú desplegable.
enableSecondAffidavit (predeterminado)
Rechazar withDecline Define si un firmante puede rechazar el paquete de documentos.
withoutDecline (predeterminado)
Razón de Rechazo withDeclineReason Define un motivo de rechazo predefinido para cuando un firmante se niega a firmar un paquete.
Rechazo Otros withDeclineOther (predeterminado) Permite que un firmante ingrese un motivo diferente para negarse a firmar un paquete.
  withoutDeclineOther Evita que un firmante introduzca un motivo diferente para negarse a firmar un paquete.
Desplegable de idiomas withLanguageDropdown (predeterminado) Define si se muestra el menú desplegable de idiomas de la página de Signer Experience.
withoutLanguageDropdown
Mostrar página de ayuda withShowNseHelp Define si se mostrará una página de ayuda, donde puede proporcionar instrucciones descriptivas, enlaces de sitios externos o información de contacto que el firmante puede usar para obtener información o instrucciones adicionales.
  withoutShowNseHelp (predeterminado)  
Vínculo de transferencia withHandOverLinkHref Sustituye al botón Continuar en la Signer Experience. Si se sustituye, el firmante será redirigido a una URL que usted especifique.
Información sobre herramientas del vínculo de transferencia withHandOverLinkHrefTooltip Define el texto que aparecerá al pasar el mouse por encima del botón de transferencia.
Parámetros de vínculo de transferencia withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS")) Define qué parámetros se agregarán a la URL de transferencia. Las opciones disponibles son ["���", "���", "���"]. Si se deja vacío, no se agregará ningún parámetro.
Redirección automática de vínculo de transferencia withHandOverLinkAutoRedirect Redirige automáticamente al firmante a la página de la URL de traspaso una vez que el firmante ha terminado de firmar.
  withoutHandOverLinkAutoRedirect (predeterminado)  
Marca de agua withWatermark (predeterminado) Define si los documentos firmados llevan estampado el logotipo de OneSpan Sign.
withoutWatermark
Texto de captura withCaptureText (predeterminado) Define si los documentos firmados se estampan con la fecha, la hora y el nombre del firmante en cada lugar donde se firmaron.
withoutCaptureText
Navegador withNavigator (predeterminado) Muestra el Navegador. El Navegador dirige al firmante a la siguiente firma disponible.
  withoutNavigator  
Título withTitle (predeterminado) Muestra el título.
  withoutTitle  
Barra de progreso withProgressBar (predeterminado) Muestra la barra de progreso.
  withoutProgressBar  
Botón Descargar withDocumentToolbarDownloadButton (predeterminado) Define si el botón Descargar está disponible.
Mostrar logotipo en iFrame withShowNseLogoInIframe Define si se debe mostrar un logotipo cuando Signer Experience se presenta el nuevo en un iFrame,
  withoutShowNseLogoInIframe (predeterminado)  
Mostrar página de resumen withShowNseOverview Define si se debe mostrar una página de resumen antes de que un firmante pueda comenzar a firmar el paquete.
  withoutShowNseOverview (predeterminado)  
Expandir menú a la izquierda withLeftMenuExpand Define si el menú de la izquierda se expandirá de forma predeterminada.
  withoutLeftMenuExpand (predeterminado)  
withoutDocumentToolbarDownloadButton
Diálogo al completar withoutDialogOnComplete (predeterminado)
withDialogOnComplete Define si después de firmar se muestra el diálogo de finalización, que pregunta a los firmantes si desean revisar los documentos o salir del sistema.

Personalización de la Signer Experience

El siguiente código de ejemplo muestra cómo editar el bloque de configuración. Los distintos elementos de la configuración se describieron anteriormente.

Si necesita una comparación con el procedimiento básico de creación de objetos o si es la primera vez que crea una transacción, consulte Crear y enviar una transacción.

 .withSettings(DocumentPackageSettingsBuilder.newDocumentPackageSettings()   .withInPerson()   .withOptOutOther()   .withDeclineOther()   .withOptOut()   .withOptOutReason("Decline terms.")   .withoutLanguageDropDown()   .hideOwnerInPersonDropDown()   .disableFirstAffidavit()   .disableSecondAffidavit()   .withDecline()   .withoutWatermark()   .withCaptureText()   .withHandOverLinkHref("http://www.google.com")   .withHandOverLinkText("Exit to site")   .withHandOverLinkTooltip("You will redirected to Google homepage")   .withDocumentToolbarDownloadButton()   .withDialogOnComplete()   .withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder.newCeremonyLayoutSettings()   .withNavigator()   .withoutGlobalNavigation()   .withoutBreadCrumbs()   .withSessionBar()   .withTitle()   .withProgressBar()   .withoutGlobalDownloadButton()   .withoutGlobalSaveAsLayoutButton()   .withLogoSource("http://www.logo-maker.net/images/common/company-logo8.gif"))) 

Resultados

Una vez que haya completado la personalización de la Signer Experience, sus firmantes verán los ajustes de personalización y el formato que haya definido para ellos.

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

La Signer Experience de OneSpan Sign se puede personalizar. Al personalizar la Signer Experience, puede integrar a la perfección el proceso de firma en su propio sitio.

Configuración del paquete de documentos

La siguiente tabla proporciona una breve descripción de los ajustes de la Signer Experience que pueden personalizarse. Tenga en cuenta que no es obligatorio especificar ninguno de estos ajustes. Si no se define un ajuste, se utilizarán los valores predeterminados que se muestran a continuación.

Nombre del ajuste Método de configuración del paquete de documentos Descripción
En persona withInPerson Define si todos los documentos de un paquete deben firmarse en el mismo dispositivo.
withoutInPerson (predeterminado)
Propietario en desplegable En persona hideOwnerInPersonDropdown Cuando la opción En persona está activada, define si el propietario del paquete está presente en el menú desplegable de firmantes.
showOwnerInPersonDropdown (predeterminado)
Primera declaración jurada disableFirstAffidavit Cuando la opción En persona está activada, define si se muestra la primera página de la declaración jurada al cambiar de firmante en el menú desplegable de firmantes.
enableFirstAffidavit (predeterminado)
Segunda declaración jurada disableSecondAffidavit Cuando la opción En persona está activada, define si se muestra la segunda página de la declaración jurada al cambiar de firmante en el menú desplegable.
enableSecondAffidavit (predeterminado)
Rechazar withDecline Define si un firmante puede rechazar el paquete de documentos.
withoutDecline (predeterminado)
Razón de Rechazo withDeclineReason Define un motivo de rechazo predefinido para cuando un firmante se niega a firmar un paquete.
Rechazo Otros withDeclineOther (predeterminado) Permite que un firmante ingrese un motivo diferente para negarse a firmar un paquete.
  withoutDeclineOther Evita que un firmante introduzca un motivo diferente para negarse a firmar un paquete.
Desplegable de idiomas withLanguageDropdown (predeterminado) Define si se muestra el menú desplegable de idiomas de la página de Signer Experience.
withoutLanguageDropdown
Mostrar página de ayuda withShowNseHelp Define si se mostrará una página de ayuda, donde puede proporcionar instrucciones descriptivas, enlaces de sitios externos o información de contacto que el firmante puede usar para obtener información o instrucciones adicionales.
  withoutShowNseHelp (predeterminado)  
Vínculo de transferencia withHandOverLinkHref Sustituye al botón Continuar en la Signer Experience. Si se sustituye, el firmante será redirigido a una URL que usted especifique.
Información sobre herramientas del vínculo de transferencia withHandOverLinkHrefTooltip Define el texto que aparecerá al pasar el mouse por encima del botón de transferencia.
Parámetros de vínculo de transferencia withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS")) Define qué parámetros se agregarán a la URL de transferencia. Las opciones disponibles son ["���", "���", "���"]. Si se deja vacío, no se agregará ningún parámetro.
Redirección automática de vínculo de transferencia withHandOverLinkAutoRedirect Redirige automáticamente al firmante a la página de la URL de traspaso una vez que el firmante ha terminado de firmar.
  withoutHandOverLinkAutoRedirect (predeterminado)  
Marca de agua withWatermark (predeterminado) Define si los documentos firmados llevan estampado el logotipo de OneSpan Sign.
withoutWatermark
Texto de captura withCaptureText (predeterminado) Define si los documentos firmados se estampan con la fecha, la hora y el nombre del firmante en cada lugar donde se firmaron.
withoutCaptureText
Navegador withNavigator (predeterminado) Muestra el Navegador. El Navegador dirige al firmante a la siguiente firma disponible.
  withoutNavigator  
Título withTitle (predeterminado) Muestra el título.
  withoutTitle  
Barra de progreso withProgressBar (predeterminado) Muestra la barra de progreso.
  withoutProgressBar  
Botón Descargar withDocumentToolbarDownloadButton (predeterminado) Define si el botón Descargar está disponible.
Mostrar logotipo en iFrame withShowNseLogoInIframe Define si se debe mostrar un logotipo cuando Signer Experience se presenta el nuevo en un iFrame,
  withoutShowNseLogoInIframe (predeterminado)  
Mostrar página de resumen withShowNseOverview Define si se debe mostrar una página de resumen antes de que un firmante pueda comenzar a firmar el paquete.
  withoutShowNseOverview (predeterminado)  
Expandir menú a la izquierda withLeftMenuExpand Define si el menú de la izquierda se expandirá de forma predeterminada.
  withoutLeftMenuExpand (predeterminado)  
withoutDocumentToolbarDownloadButton
Diálogo al completar withoutDialogOnComplete (predeterminado)
withDialogOnComplete Define si después de firmar se muestra el diálogo de finalización, que pregunta a los firmantes si desean revisar los documentos o salir del sistema.

La siguiente tabla proporciona una breve descripción de las secciones de formato que se pueden personalizar. Tenga en cuenta que no es obligatorio especificar ninguno de estos ajustes. Si no se define un ajuste, se utilizarán los valores predeterminados que se muestran a continuación.

Nombre del ajuste Método de configuración de formato de ceremonia Descripción
Navegador withNavigator (predeterminado) Muestra el Navegador. El Navegador dirige al firmante a la siguiente firma disponible.
withoutNavigator
Navegación global withGlobalNavigation (predeterminado) Muestra la navegación global.
withoutGlobalNavigation
Rutas de navegación withBreadCrumbs (predeterminado) Muestra las rutas de navegación de las firmas.
withoutBreadCrumbs
Barra de sesión withSessionBar (predeterminado) Muestra la barra de sesión.
withoutSessionBar
Título withTitle (predeterminado) Muestra el título.
withoutTitle
Barra de progreso withProgressBar (predeterminado) Muestra la barra de progreso.
withoutProgressBar
Logotipo withLogoSource Sustituye el logotipo predeterminado de OneSpan Sign por un logotipo personalizado. Se debe pasar una URL válida al logotipo personalizado como argumento.
Botón Descargar withGlobalDownloadButton (predeterminado) Muestra el botón Descargar en el área de acciones globales.
withoutGlobalDownloadButton
Botón Guardar como formato withGlobalSaveAsLayoutButton (predeterminado) Muestra el botón Guardar como formato en el área de acciones globales.
withoutGlobalSaveAsLayoutButton

Personalización de la Signer Experience

El siguiente código de ejemplo muestra cómo editar el bloque de configuración. Los distintos elementos de la configuración se describieron anteriormente.

Si necesita una comparación con el procedimiento básico de creación de objetos o si es la primera vez que crea una transacción, consulte Crear y enviar una transacción.

 .withSettings(DocumentPackageSettingsBuilder.newDocumentPackageSettings()
				.withInPerson()
				.withLanguageDropDown()
				.hideOwnerInPersonDropDown()
				.disableFirstAffidavit()
				.disableSecondAffidavit()
				.withDecline()
				.withDeclineOther()
				.withDeclineReason("some reason")
				.withoutWatermark()
				.withoutCaptureText()
				.withoutHandOverLinkAutoRedirect()
				.withHandOverLinkHref("http://www.google.com")
				.withHandOverLinkTooltip("You will redirected to Google homepage")
				.withHandOverLinkParameters(Sets.newHashSet("PACKAGE", "SIGNER", "STATUS"))
				
				.withLeftMenuExpand()
				.withShowNseHelp()
				.withShowNseLogoInIframe()
				.withShowNseOverview()
				.withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder.newCeremonyLayoutSettings()
							.withoutNavigator()
							.withoutProgressBar()
							.withoutTitle()
							.withGlobalDownloadButton()

Resultados

Una vez que haya completado la personalización de la Signer Experience, sus firmantes verán los ajustes de personalización y el formato que haya definido para ellos.

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

La Signer Experience de OneSpan Sign se puede personalizar. Al personalizar la Signer Experience, puede integrar a la perfección el proceso de firma en su propio sitio.

Configuración del paquete de documentos

La siguiente tabla proporciona una breve descripción de los ajustes de la Signer Experience que pueden personalizarse.

Nombre del ajuste

Método de configuración del paquete de documentos

Descripción

En persona

ajustes > ceremonia > presencial

Define si todos los documentos de un paquete deben firmarse en el mismo dispositivo.

Propietario en desplegable En persona

ajustes > ceremonia > ocultar propietario del paquete presencial

Cuando la opción En persona está activada, define si el propietario del paquete está presente en el menú desplegable de firmantes.

Primera declaración jurada

ajustes > ceremonia > desactivar la primera declaración jurada presencial

Cuando la opción En persona está activada, define si se muestra la primera página de la declaración jurada al cambiar de firmante en el menú desplegable de firmantes.

Segunda declaración jurada

ajustes > ceremonia > desactivar la segunda declaración jurada presencial

Cuando la opción En persona está activada, define si se muestra la segunda página de la declaración jurada al cambiar de firmante en el menú desplegable.

Rechazar

ajustes > ceremonia > botón Rechazar

Define si un firmante puede rechazar el paquete de documentos.

Motivo de rechazo

ajustes > ceremonia > Motivos de rechazo

Define un motivo de rechazo predefinido para cuando un firmante se niega a firmar un paquete.

Rechazo Otros

ajustes > ceremonia > desactivar rechazar otros

Permite que un firmante ingrese un motivo diferente para negarse a firmar un paquete.

Desplegable de idiomas

ajustes > ceremonia > ocultar el menú desplegable de idiomas

Define si se muestra el menú desplegable de idiomas de la página Experiencia del firmante.

Mostrar página de ayuda

ajustes > ceremonia > mostrar ayuda Nse

Define si se mostrará una página de ayuda, donde puede proporcionar instrucciones descriptivas, enlaces de sitios externos o información de contacto que el firmante puede usar para obtener información o instrucciones adicionales.

Vínculo de transferencia

ajustes > ceremonia > transferencia > href

Sustituye al botón de continuar en la Experiencia del Firmante. Si se sustituye, el firmante será redirigido a una URL que usted especifique.

Información sobre herramientas del vínculo de transferencia

ajustes > ceremonia > transferencia > título

Define el texto que aparecerá al pasar el mouse por encima del botón de transferencia.

Parámetros de vínculo de transferencia

ajustes > ceremonia > transferencia > parámetros

Define qué parámetros se agregarán a la URL de transferencia. Las opciones disponibles son ["PACKAGE", "SIGNER", "STATUS"]. Si se deja vacío, no se agregará ningún parámetro.

Redirección automática de vínculo de transferencia

ajustes > ceremonia > transferencia > redirección automática

Redirige automáticamente al firmante a la página de la URL de traspaso una vez que el firmante ha terminado de firmar.

Marca de agua

ajustes > ceremonia > ocultar marca de agua

Define si los documentos firmados se sellan con el logotipo de OneSpan Sign.

Texto de captura

ajustes > ceremonia > ocultar texto de captura

Define si los documentos firmados se estampan con la fecha, la hora y el nombre del firmante en cada lugar donde se firmaron.

Navegador

ajustes > ceremonia > disposición > navegador

Muestra el Navegador. El Navegador dirige al firmante a la siguiente firma disponible.

Título

ajustes > ceremonia > disposición > encabezado > título Barra > título

Muestra el título.

Botón Descargar

ajustes > ceremonia > opciones de la barra de herramientas del documento > botón de descarga

Define si el botón Descargar está disponible.

Mostrar logotipo en iFrame

ajustes > ceremonia > mostrar logotipo Nse en Iframe

Define si se debe mostrar un logotipo cuando la nueva experiencia para firmantes se presenta en un iFrame,

Mostrar página de resumen

ajustes > ceremonia > mostrar descripción Nse

Define si se debe mostrar una página de resumen antes de que un firmante pueda comenzar a firmar el paquete.

Expandir menú a la izquierda

ajustes > ceremonia > expandir menú izquierdo

Define si el menú de la izquierda se expandirá de forma predeterminada.

 

Personalización de la Signer Experience

El JSON de ejemplo que aparece a continuación muestra cómo editar el objeto de configuración. Cada método se ha descrito anteriormente en la sección Configuración de nivel de paquete de documentos.

Si necesita una comparación con el procedimiento básico de creación de objetos o si es la primera vez que crea una transacción, consulte Crear y enviar una transacción.

Solicitud HTTP

POST /api/packages

Encabezados HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key
 {   "name": "Customizing Signer Experience",   "settings": {   "ceremony": {   "events": {   "complete": {   "dialog": true,   "redirect": ""   }   },   "inPerson": true,   "declineButton": true,   "declineReasons": [],   "disableDeclineOther": false,   "disableDownloadForUncompletedPackage": false,   "disableFirstInPersonAffidavit": true,   "disableInPersonAffidavit": false,   "disableOptOutOther": false,   "disableSecondInPersonAffidavit": true,   "documentToolbarOptions": {   "downloadButton": true   },   "handOver": {   "title": "You will be redirected to Google homepage",   "href": "http://www.google.com",   "text": "Exit to site"   },   "hideCaptureText": false,   "hideLanguageDropdown": true,   "hidePackageOwnerInPerson": true,   "hideWatermark": true,   "maxAuthFailsAllowed": 3,   "optOutButton": true,   "optOutReasons": [   "Decline terms."   ],   "style": null,   "layout": {   "footer": {},   "navigator": true,   "brandingBar": {   "logo": {   "src": "http://www.logo-maker.net/images/common/company-logo8.gif",   "link": ""   }   },   "header": {   "feedback": true,   "globalActions": {   "confirm": true,   "download": false,   "hideEvidenceSummary": false,   "saveAsLayout": false   },   "titleBar": {   "title": true,   "progressBar": true   },   "breadcrumbs": false,   "globalNavigation": false,   "sessionBar": true   }   }   }   },   "type": "PACKAGE",   "status": "DRAFT"   } 

Carga útil de respuesta

 {   "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="   } 

Resultados

Una vez que haya completado la personalización de la Signer Experience, sus firmantes verán los ajustes de personalización y el formato que haya definido para ellos.