PadConnector Pro XML (ES)

El XML permite crear un proceso de firma con una posición de firma definida. El XML es un contenedor que contiene el documento PDF como flujo base64, la información de las posiciones de firma y los valores de configuración. Después de firmar, puede obtener el XML de devolución, que contiene el documento firmado e información adicional sobre las firmas.

 

Definición de los campos de firma

Hay 3 formas de encontrar las posiciones de las firmas dentro del documento.

  • coordenadas estáticas (<Static/>), lo que significa que usted define la posición en centímetros dentro de una página. Si los documentos son estáticos, puede colocar fácilmente sus firmas.

  • La búsqueda inteligente (<Signature>), es recomendable si sus documentos son dinámicos y la posición de la firma cambia dependiendo del contenido. Para la colocación utilizamos la función de búsqueda de texto, para colocar la firma junto a un texto de búsqueda que está cerca de la sigantura. Esto permite el uso de documentos dinámicos, lo importante es que la posición de la firma junto al texto de búsqueda sea la misma y que el texto de búsqueda pueda ser encontrado. Si un texto de búsqueda no se encuentra la firma será ignorada, esto significa que usted puede crear una plantilla xml para diferentes diseños de documentos, sólo tiene que asegurarse de que el texto de búsqueda es lo suficientemente específico como para que no se encuentre en posiciones que no desea. También puede ocultar los textos de búsqueda utilizando un color de texto blanco sobre fondo blanco.

  • using existing signature fields <DigSig/>. In case the document already has empty signature fields you can also use them.

Etiquetas XML

La documentación XML se basa siempre en el firmware más reciente. En caso de que tengas problemas con determinadas etiquetas XML, ejecuta una actualización del firmware para comprobar si se soluciona el problema.

Nombre

Requerido

Descripción

Nombre

Requerido

Descripción

<PDF>

The document as base64 stream

<Signatures>

Una la sección que define los campos de firma que se ofrecen al usuario cuando entra en el modo de firma.

Los campos definidos en el documento XML se gestionan de la misma forma que los campos de firma inteligente contenidos en los archivos SSS.

<Signature>

 

 

 

 

Al menos una de las etiquetas<Signature>, <Static> o <DigSig> es necesaria para definir las posiciones de las firmas. Es posible una combinación de diferentes colocaciones de firma.

Cada firma es una etiqueta independiente. El número de campos de firma no está limitado.

Posteriormente se definen las etiquetas agrupadas de <Signature>.

<Static>

Declare un campo estático, como alternativa a los campos inteligentes declarados con <Signature>.

Las propiedades de los campos estáticos deben definirse mediante etiquetas secundarias. Las posibles etiquetas hijas son <Page>,<X>,<Y>. La etiqueta <Page> permite establecer también valores negativos (-1 para la última página, -2 la página anterior a la última; etc...). Si la etiqueta <Page> se establece en 0, el campo de firma se ignorará.

<Static> <Page>1</Page> <X>3.5</X> <Y>21.5</Y> <Height>3.1</Height> <Width>5</Width> </Static>

<DigSig>

Declara un campo de firma vacío, que ya está dentro del documento PDF. Es una alternativa a los campos estáticos e inteligentes.

<FieldName>

Sí, como parte de <DigSig>

Contiene el nombre del campo Firma, que ya está dentro del PDF.

<Placeholder>

Sí, como parte de<Signature>

Contiene la subcadena de anclaje, que se utiliza para buscar campos de firma.

<Width> and <Height>

Sí, como parte de <Static> and <Signature>

Define el tamaño de los campos de firma en centímetros.

<DisplacementTLIndex> or <VersatzOLIndex>

Opcional como parte de <Signature>

Define la posición del punto de anclaje dentro del rectángulo, rodeando la cadena clave. Valores posibles:

1 - arriba a la izquierda

2 - arriba centro

3 - superior derecha

4 - centro izquierda

5 - centro

6 - centro derecha

7 - abajo izquierda

8 - abajo centro

9 - abajo a la derecha

 

Puede representarse visualmente como una matriz de 3x3:

1   2   3

4   5   6

7   8   9

(parte de <Signature>)

<FeldPositionIndex>

Opcional como parte de <Signature>

Define la posición del campo con respecto a la cadena clave.

(parte de <Signature>)

<Offset_X> and <Offset_Y>

Opcional como parte de <Signature>

Son etiquetas opcionales. Especificando valores distintos de cero, es posible desplazar el campo de firma el número de centímetros dado.

Los valores positivos desplazan el campo hacia la derecha / abajo, los negativos hacia la izquierda / arriba.

(part of <Signature>)

<Mandatory/>

Opcional

Es un campo opcional que indica que el campo de firma es obligatorio.

Nota: webSignatureOffice espera un valor para esta etiqueta: <Mandatory>1</Mandatory> significa campo obligatorio, <Mandatory>0</Mandatory> significa campo opcional.

<SignatureDisplayPlacement>

Example:

<SignatureDisplayPlacement>

<MaxWidth>40</MaxWidth>

<MaxHeight>20</MaxHeight>

<RectPosX>10</RectPosX>

<RectPosY>80</RectPosY>

</SignatureDisplayPlacement>

Opcional como parte <Signature> o en<ESign> como opción global para cada firma sin la opción individual.

Etiquetas opcionales que definen la posición y el tamaño del campo de firma (rectángulo) en la pantalla del dispositivo.

<RectPosX> y <RectPosY> sirve para colocar la firma. Puede utilizar sólo uno de los valores o combinar ambos. El valor por defecto es 50 % que es el centro de la pantalla.

(0, 0) es la esquina superior izquierda y (100, 100) es la esquina inferior derecha.

RectPos-0and0.png
RectPos-100and100.png

<MaxWidth> y <MaxHeight> sirven para ajustar el tamaño de la firma. Puede utilizar sólo uno de los valores o combinar ambos. En caso de utilizar ambos valores, el dispositivo hará zoom hasta que se alcance el primero de los dos valores. Si utiliza estos valores, los valores de zoom quedarán obsoletos.

El intervalo de valores oscila entre el 10% y el 100%.

<Stamp>

 

Example:

<Stamp>

<Position>BottomLeft</Position>

<Text>Unterzeichnet von:  [Signer]\r\n
              Grund:  [Reason]\r\n
              Ort:    [Location]\r\n
              Zeit:   [Time]
</Text>

<Size>12</Size>

<Color>0x0000FF</Color>
</Stamp>
<Signer>Homer Simson</Signer>
<Reason>Bestätige den Inhalt</Reason>
<Location>Springfield</Location>

Opcional

Es una etiqueta opcional. Especifica el sello de firma (texto), que se almacena junto con la imagen de firma en la página del documento

<Text> La etiqueta debe contener el texto del sello. Nueva línea se puede introducir con símbolos \r\n.

<Color> Define el color del texto. En formato hexadecimal, representa las intensidades de color RGB para el azul, el verde y el rojo.

El valor 0x00FF0000 representa la intensidad completa, azul puro, 0x0000FF es verde puro y 0xFF0000 es rojo puro. 0x000000 es negro y 0xFFFFFF es blanco.

<Font> y <Size> Definen la fuente y el tamaño respectivamente.

<Position> define la posición del sello en la imagen de la firma. por defecto es BottomLeft.

Estos son todos los valores posibles:

  • <Position>BottomLeft</Position>

    <Position>TopLeft</Position>

    <Position>TopRight</Position>

    <Position>BottomRight</Position>

    <Position>CenterLeft</Position>

    <Position>CenterRight</Position>

    <Position>Center</Position>

Encontrará información sobre el marcador de posición del sello aquí.

<Signer>, <Reason> and <Location>

Opcional

Las etiquetas pueden utilizarse para especificar el nombre del firmante, el motivo de la firma y la ubicación de la firma, respectivamente.

<AutoStartSig>

Opcional

Si se incluye esta etiqueta, el dispositivo comienza a firmar automáticamente después de abrir el documento.

<Signed>

Valor de retorno

Esta etiqueta se añade al resultado xml para indicar si la firma se ha añadido u omitido. Mediante <Placeholder> firma los valores es 1 (para firmado) cuando al menos uno de la posición encontrada fue firmado. Para los detalles de la firma individual se añadirá el <SignedProtocol>

Valores:

0 = no firmado

1 = firma realizada

<SignedProtocol>*
<Index id="1">0</Index>
<Index id="2">1</Index>
...
</SignedProtocol>

Valor de retorno

Esta etiqueta se añade al resultado xml para cada firma <Placeholder> que se encontró dentro del documento. Hay un índice separado para cada posición de marcador de posición que se encontró dentro del pdf.

Valores:

0 = no firmado

1 = firma realizada

<Found>

Valor de retorno

Esta etiqueta se añade al xml resultante para indicar si se ha encontrado la posición de la firma (<FieldName> y <Placeholder>)

Valores:

0 = no se encuentra en el documento

1 = se encuentra dentro del documento

*this XML Tags are not implemented/published yet and will be added in the future.

XSD Sets

Samples for the Signature Placements

<Signatures> <Static> <Page>1</Page> <X>3.5</X> <Y>21.5</Y> <Height>3.1</Height> <Width>5</Width> <Signed>0</Signed> <Found>0</Found> ... </Static> ... </Signatures>
<Signatures> <Signature> <Placeholder>Signature Customer</Placeholder> <Width>4</Width> <Height>3</Height> <DisplacementTLIndex>7</DisplacementTLIndex> <FeldPositionIndex>3</FeldPositionIndex> <Offset_X>0</Offset_X> <Offset_Y>-3</Offset_Y> <Signed>0</Signed> <Found>0</Found> ... </Signature> ... </Signatures>

 

Sample XML-Files

Static coordinates:

Placeholder search:

existing Signaturefields: