Sobre este documento

Este documento tiene el objetivo de describir los parámetros necesarios para realizar la personalización de la App SIGNply 3.0

 

Introducción

Descripción de los diferentes parámetros que intervienen en la configuración del fichero TXT de personalización.

 

Parámetros de llamada 

Documento

  • “document-title” (Texto): literal que aparece en el ítem del listado de documentos pendientes y en la visualización de documento (barra superior).
  • “document-description” (Texto): literal que aparece en el ítem del listado de documentos pendientes.
  •  

Modo firma

  • jsigmode” (Booleano): firma con biometría (=0) o electrónica (=1). OBLIGATORIO.
    • Su valor debe ser booleano (0 o 1).
  •  

Widget

  • widget-type” (Texto): tipo de posicionamiento. OBLIGATORIO.
    •  Valores permitidos: “manual”, “field”, “fixed” y “float”.

  • widget-manual-ratio” (Float): ratio (relación entre el ancho y el alto de widget) para posicionamiento manual. Por defecto 4.
    • Si es informado su valor se debe encontrar en el rango [1,4].

  • widget-field-fieldname” (Texto): nombre de campo preexistente en el que se incrusta el widget.
    • Es OBLIGATORIO si “widget-type”=”field”.
    • No puede ser nulo o vacío.

  • widget-fixed-page“ (Entero): número de página en el que se incrusta el widget.
    • Es OBLIGATORIO si “widget-type”=”fixed”.
    • Su valor debe ser mayor o igual a 0.

  • widget-fixed-x“ (Entero): indica el desplazamiento en horizontal de la posición del widget desde el vértice inferior izquierdo de la página de un documento.
    • Es OBLIGATORIO si “widget-type”=”fixed”.
    • Su valor debe ser mayor o igual a 0.

  • widget-fixed-y“ (Entero): indica el desplazamiento en vertical de la posición del widget desde el vértice inferior izquierdo de la página de un documento.
    • Es OBLIGATORIO si “widget-type”=”fixed”.
    • Su valor debe ser mayor o igual a 0.

  • widget-float-text” (Texto): indica la cadena a buscar dentro del documento donde se incrusta el widget. Devuelve el primer resultado obtenido. Este parámetro es sensible a mayúsculas y a minúsculas.
    • Es OBLIGATORIO si “widget-type”=”float”.
    • No puede ser nulo o vacío.

  • widget-float-gap-x” (Entero): indica el número entero de unidades de desfase (positivo o negativo) en horizontal desde el vértice inferior izquierdo del texto buscado..
    • Es OBLIGATORIO si “widget-type”=”float”.

  • widget-float-gap-y” (Entero): indica el número entero de unidades de desfase (positivo o negativo) en vertical desde el vértice inferior izquierdo del texto buscado.
    • Es OBLIGATORIO si “widget-type”=”float”.

  • widget-width” (Entero): ancho del widget.
    • Es OBLIGATORIO si “widget-type”=”fixed” o “float”.
    • Su valor debe ser mayor de 0 si “jsigmode”=”0”.
    • Su valor debe ser mayor o igual a 0 si “jsigmode=”1”.

  • widget-height” (Entero): alto del widget.
    • Es OBLIGATORIO si “widget-type”=”fixed” o “float”.
    • Su valor debe ser mayor de 0 si “jsigmode”=”0”.
    • Su valor debe ser mayor o igual a 0 si “jsigmode=”1”.

El ratio (relación entre el ancho y el alto de widget) debe estar comprendido entre [1,4].

  • widget-custom-text-b64” (Texto): texto personalizado en base 64 para el widget.
    • Si es informado debe estar bien construido.
  •  

Firma PAdES

Certificados
    • sign-cert-p12-b64” (Texto): certificado de firma en base 64.
  • Si es informado no puede ser nulo o vacío y debe estar bien construido.
    • sign-cert-password-b64” (Texto): password de certificado de firma en base 64.
      • Si es informado debe estar bien construido.
    • enc-key-b64” (Texto): certificado de cifrado de datos biométricos en base 64.
  • Si es informado no puede ser nulo o vacío y debe estar bien construido.
Tsp
  • tsp-activate” (Booleano): activación de introducción de sello de tiempo.

El resto de parámetro solo aplican cuando “tsp-activate”=1.

    • tsp-url” (Texto): url de TSP. OBLIGATORIO.
  • No puede ser nulo o vacío.
    • Debe comenzar por el protocolo http ó https.
  • tsp-user” (Texto): usuario de TSP.
  • tsp-password-b64” (Texto): password de TSP en base 64.
    • Si es informado debe estar bien construido.
Ocsp
  • ocsp-activate” (Booleano): activación de introducción de sello de tiempo.

El resto de parámetro solo aplican cuando “ocsp-activate”=1.

    • ocsp-url” (Texto): url de OCSP. OBLIGATORIO.
  • No puede ser nulo o vacío.
    • Debe comenzar por el protocolo http ó https.
  • ocsp-user” (Texto): usuario de OCSP.
  • ocsp-password-b64” (Texto): password de OCSP en base 64.
    • Si es informado debe estar bien construido.
OTP
  • otp-activate (Booleano): activación de otp.
    • Si es informado su valor debe ser booleano (0 o 1).

El resto de parámetro solo aplican cuando “otp-activate”=1.

  • otp-window-size (Entero)tiempo de ventana en la que el otp es válido (en salto de ventana, cada salto es de 30 segundos). Por defecto 10 (5 minutos).
    • Si es informado su valor debe ser mayor de 0.
  • opt-system-sms (Entero): sistema de envío de los sms. OBLIGATORIO.
  • otp-user (Texto): usuario de plataforma de envío de sms. OBLIGATORIO.
    • No puede ser nulo o vacío.
  • otp-password-b64 (Texto): password en base 64 de la plataforma de envío de sms.
    • Si es informado debe estar bien construido.
  • otp-from (Texto): remitente de sms. OBLIGATORIO.
    • No puede ser nulo o vacío.
  • otp-unicode (Booleano): uso de unicode o no (para uso de tildes y caracteres raros se debe activar, limitando la longitud máxima del sms de 160 a 70 caracteres). Por defecto 0.
    • Si es informado su valor debe ser booleano (0 o 1).
  • otp-text (Texto): contenido o texto del sms. OBLIGATORIO.
    • No puede ser nulo o vacío.
    • Debe contener la cadena ##OTP## para informar al receptor el código otp generado.
  • otp-send-to (Texto): número de teléfono de envío de sms. OBLIGATORIO.
    • No puede ser nulo o vacío.
    • Debe comenzar por un código de país. Ejemplos: +34, +54, …
    • Debe ser válido.
    •  

Licencia

  • license-b64” (Texto): licencia de ESS en base 64.
    • Si es informado no puede ser nulo o vacío y debe estar bien construido.

El base 64 informado puede proceder:

      • de un archivo .lic.
      • de un string con las líneas separadas por el carácter “|” (como se informa ahora en la personalización del SIGNply antiguo).
  • Share: