The NextGen XML allows to create a signature process with defined signature position. The XML is a container which contains the PDF document as base64 stream, the information of the signature positions and configuration values. After signing you can collect the Return-XML which contains the signed document and additional information of the signatures.
| Table of Contents |
|---|
Signature fields Definition
There are 3 ways to find the signature positions inside the document.
static coordinates (
<Static/>), which means you define the postion within centimeters inside a page. If documents are static you can very easy place your signatures.intelligent search (
<Signature>), is recommend if your documents are dynamic and the signature postion is changing depending of the content. For the placement we using the text search function, to place the signature next to a search text which is near the siganture. This allows the usage of dynamic documents, important is only that the signature placement to the search text stays the same and the search text can be found. If a search text is not found the signature will be ignored, this means you can create a template xml for different document layout, you only need to be sure that the search text is specific enough that it will not be found at postions you do not want. You can also hide the search texts by using white text colour on white background.using existing signature fields
<DigSig/>. In case the document already has empty signature fields you can also use them.
XML Tags
| Info |
|---|
The XML documentation is always based on the latest firmware. In case you have problems with specific XML Tags, please run a firmware update to check if that solves the issue. |
...
Name
...
Required
...
Description
...
<PDF>
...
Yes
...
The document as base64 stream
...
<Signatures>
...
Yes
...
Unites the section, that defines signature fields, offered to user, when he enters signing mode.
Fields, defined in XML document are handled the same way as intelligent signature fields contained in SSS files.
...
<Signature>
At least one of the tags <Signature>, <Static> or <DigSig> is required to define the signature positions. A combination of different signature placement is possible.
...
Each signature is a separate tag. The number of signature fields are not limited
Nested tags of <Signature> are defined below.
...
<Static>
Declares a static field, as alternative to intelligent fields declared with <Signature>.
...
El XML NextGen permite crear un proceso de firma con una posición de firma definida. El XML es un contenedor que contiene el documento PDF codificado en base64, la información de las posiciones de los campos de firma y los valores de configuración. Después de firmar, puede recopilar el XML de devolución, que contiene el documento firmado e información adicional sobre las firmas.
| Table of Contents |
|---|
Definición de Campos de firma
Hay 3 formas de posicionar 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.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 donde queremos establecer el campo de firma. 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, lo que significa que usted puede crear una misma plantilla xml para diferentes diseños de documentos y 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.Utilizando los campos de firma existentes
<DigSig/>. En caso de que el documento ya tenga campos de firma digital vacíos, puede utilizarlos.
Etiquetas XML
| Info |
|---|
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 | |||||
|---|---|---|---|---|---|---|---|
| Sí | El documento como secuencia base64 | |||||
| Sí | Une 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 del mismo modo que los campos de firma inteligente contenidos en los archivos SSS. | |||||
| Al menos una de las etiquetas | Cada firma es una etiqueta independiente. El número de campos de firma no está limitado A continuación se definen las etiquetas agrupadas de | |||||
| Define un campo estático, como alternativa a los campos inteligentes definidos con Las propiedades estáticas de los campos deben definirse mediante etiquetas secundarias. Las posibles etiquetas secundarias son
| ||||||
| Declares an empty signature field, which is already inside the PDF document. It's an alternative to static and intelligent fields. |
| Yes as part of | Contains the name of the Signature field, which is already inside the Define un campo de firma vacío, que ya se encuentra dentro del documento PDF. Es una alternativa a los campos estáticos e inteligentes. | |||
| Sí, como parte de | Contiene el nombre del campo Firma, que ya está dentro del PDF. | |||||
| Yes, as part of | Contains anchor substring, that is used to find signature fieldsSí, como parte de | Contiene la subcadena de anclaje, que se utiliza para buscar campos de firma. | ||||
| Yes, as part of | Defines signature field sizes in centimetersSí, como parte de | Define el tamaño de los campos de firma en centímetros. | ||||
| Optional as part of | Defines the position of the anchor point inside rectangle, surrounding the key string. Can be represented visually as 3x3 matrixOpcional como parte de | Define la posición del punto de anclaje dentro del rectángulo, rodeando la cadena clave. Puede representarse visualmente como una matriz 3x3: 1 2 3 4 5 6 7 8 9 More information can be found hereEncontrará más información aquí. | ||||
| Optional as part of | Defines the position of the field relatively to the key string based on a 3x3 matrix simelar to DisplacementTLIndex, just mirroredOpcional como parte de | Define la posición del campo con respecto a la cadena de claves basándose en una matriz 3x3 similar a DisplacementTLIndex, pero reflejada. 9 8 7 6 5 4 3 2 1 | ||||
| Optional as part of | Are optinal tags. By specifying non-zero values, it's possible to move the signature field by the given number of centimetres. Positive values move the field to the right / bottom, negative values to the left / top. More information can be found hereOpcional como parte de | 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 a la derecha / abajo, los negativos a la izquierda / arriba. Encontrará más información aquí. | ||||
| Optional | Is an optional field indicating that signature field is mandatory. Please note: webSignatureOffice expects a value for this tag: <Mandatory>1</Mandatory> means mandatory field, <Mandatory>0</Mandatory> means optional field | |||||
| Optional | Is an optional tag, that defines zoom values for the document in eSignatureOffice/webSign/secureSign for a particular signature field. Text inside the tag can be either an integer value in range 10..300 (denotes percent) or Fit, that means fit to Screen or Width, that means fit to page width. The default zoom value is 100 percent. | |||||
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. | ||||||
| Opcional | Es una etiqueta opcional que define valores de zoom para el documento en eSignatureOffice/webSign/secureSign para un campo de firma concreto. El texto dentro de la etiqueta puede ser un valor entero en el rango 10..300 (indica porcentaje) o Ajustar, que significa ajustar a la pantalla o Ancho, que significa ajustar al ancho de la página. El valor de zoom predeterminado es 100 por cien. | |||||
| Optional as part of | Optional tags, that are defining the position and sizing of the signature field (rectangle) on the device display.
| Etiquetas opcionales que definen la posición y el tamaño del campo de firma (rectángulo) en la pantalla del dispositivo.
(0, 0) is upper left corner and es la esquina superior izquierda y (100, 100) is bottom-right corneres la esquina inferior derecha.  
El intervalo de valores oscila entre el 10% y el 100%.  | ||||
| Optional | Is an optional tag. Specifies signature stamp (text), that is stored together with signature image on document page.
The value 0x00FF0000 represents full-intensity, pure blue, 0x0000FF is pure green, and 0xFF0000 is pure red. 0x000000 is black and 0xFFFFFF is white.
<Posistion> defines the position of the stamp on signature image. default is BottomLeft. hier are all posible valuesOpcional | 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.
El valor 0x00FF0000 representa la intensidad total, azul puro, 0x0000FF es verde puro y 0xFF0000 es rojo puro. 0x000000 es negro y 0xFFFFFF es blanco.
Estos son todos los valores posibles:
Information about the stamp placeholder can be find hereEncontrará información sobre el marcador de posición del sello aquí. | ||||
| Optional | Tags can be used to specify signer name, reason for signing and signing location respectively. | |||||
| Optional | If this tag is included, the device starts signing automatically after document is opened. | |||||
| Return Value | This tag is added into the result xml, to indicate if the signature was added or skipped. By Values: 0 = not signed 1 = signature was signedOpcional | Las etiquetas pueden utilizarse para especificar el nombre del firmante, el motivo de la firma y la ubicación de la firma, respectivamente | ||||
| Opcional | Si se incluye esta etiqueta, el dispositivo comienza a firmar automáticamente después de abrir el documento. | |||||
| Valor de retorno | Esta etiqueta se añade al resultado xml para indicar si la firma se ha añadido u omitido. Para el Valores: 0 = no firmado 1 = firma realizada | |||||
| Return Value | This tag is added to the result xml for each Values: 0 = not signed 1 = signature was signed | |||||
| Return Value | This tag is added into the result xml, to indicate if the signature position ( Values: 0 = not found in the document 1 = found inside the document |
...
Valor de retorno | Esta etiqueta se añade al resultado xml para cada firma Valores: 0 = no firmado 1 = firma realizada | ||
| Valor de retorno | Esta etiqueta se añade al xml resultante para indicar si se ha encontrado la posición de la firma ( Valores: 0 = no se encuentra en el documento 1 = se encuentra dentro del documento |
*estas etiquetas XML aún no se han implementado/publicado y se añadirán en el futuro.
XSD Sets
| View file | ||
|---|---|---|
|
...
Ejemplos para la colocación de firmas
|
...
|
...
Ejemplos de archivos XML
...
Static coordinatesCoordenadas estáticas:
| View file | ||
|---|---|---|
|
Placeholder searchBúsqueda de marcadores de posición:
| View file | ||
|---|---|---|
|
existing SignaturefieldsCampos de Firma existentes:
| View file | ||
|---|---|---|
|
...