Versions Compared

Old Version 3

changes.mady.by.user Editor

Saved on

compared with

New Version Current

changes.mady.by.user Editor

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

  • 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

...

...

<PDF>

...

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

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.

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.

Nombre

Requerido

Descripción

<PDF>

Sí

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>

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>.

Static field properties must be defined by child tags. Possible child tags are Sí

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>. The <Page> tag allows you to set also negative values (-1 for last page, -2 the page before the last pageLa etiqueta <Page> permite establecer también valores negativos (-1 para la última página, -2 la página anterior a la última; etc...). If the <Page> tag is set to 0, the signature field will be ignoredSi la etiqueta <Page> se establece en 0, el campo de firma se ignorará.

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

<DigSig>

Declares an empty signature field, which is already inside the PDF document. It's an alternative to static and intelligent fields.

<FieldName>

Yes as part of <DigSig>

Contains the name of the Signature field, which is already inside the 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>

Yes, as part of <Signature>

Contains anchor substring, that is used to find signature fieldsSí, como parte de<Signature>

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

<Width> and <Height>

Yes, as part of Sí, como parte de <Static> and <Signature>

Defines signature field sizes in centimetersDefine el tamaño de los campos de firma en centímetros.

<DisplacementTLIndex> or <VersatzOLIndex>

Optional as part of <Signature>

Defines the position of the anchor point inside rectangle, surrounding the key string. Possible valuesOpcional como parte de <Signature>

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

1 -  top leftarriba a la izquierda

2 – top center- arriba centro

3 – top right- superior derecha

4 – center left- centro izquierda

5 – center- centro

6 – center right- centro derecha

7 – bottom left- abajo izquierda

8 – bottom center

9 – bottom right

Can be represented visually as 3x3 matrix- abajo centro

9 - abajo a la derecha

Puede representarse visualmente como una matriz de 3x3:

1   2   3

4   5   6

7   8   9

(part of parte de <Signature>)

<FeldPositionIndex>

Optional as part of <Signature>

Defines the position of the field relatively to the key string.

(part of 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>

Optional as part of <Signature>

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 / topOpcional 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/>

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 fieldOpcional

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>

Optional as part of <Signature> or under <ESign> as global option for every signature without the individual option

Optional tags, that are defining the position and sizing of the signature field (rectangle) on the device display.

<RectPosX> and <RectPosY> is for placing the signature. You can use only one of the values or combine both of them. The default value is 50 % which is the center of the screenOpcional 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) is upper left corner and es la esquina superior izquierda y (100, 100) is bottom-right corneres la esquina inferior derecha.

RectPos-0and0.pngRectPos-100and100.png

<MaxWidth> and <MaxHeight> is for sizing of the signature based. You can use only one of the values or combine both of them. In case you using both values, the device will zoom until the first of the two values is reached. When using this values the Zoom Values will become obsolete.

The value range is between 10 and 100 percent.

MaxWidth.pngImage Removed

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>

Optional

Is an optional tag. Specifies signature stamp (text), that is stored together with signature image on document page.

<Text> Tag should contain stamp text. New line can be entered with \r\n symbols.

<Color> Defines text Color. In hexadecimal format, it represents RGB color intensities for blue, green, and red.

The value 0x00FF0000 represents full-intensity, pure blue, 0x0000FF is pure green, and 0xFF0000 is pure red. 0x000000 is black and 0xFFFFFF is white.

<Font> and <Size> Defines font face and size respectively.

<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

<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>

Information about the stamp placeholder can be find hereEncontrará información sobre el marcador de posición del sello aquí.

<Signer>, <Reason> and <Location>

Optional

Tags can be used to specify signer name, reason for signing and signing location respectivelyOpcional

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

<AutoStartSig>

Optional

If this tag is included, the device starts signing automatically after document is openedOpcional

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

<Signed>

Return Value

This tag is added into the result xml, to indicate if the signature was added or skipped. By <Placeholder> signatures the values is 1 (for signed) when at least one of the found postion was signed. For individual signature details the <SignedProtocol> will be added.

Values:

0 = not signed

1 = signature was signedValor 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>

Return Value

This tag is added to the result xml for each <Placeholder> signature which was found inside the document. There is a separate index for each placeholder position which was found inside the pdf.

Values:

0 = not signed

1 = signature was signed

<Found>

Return Value

This tag is added into the result xml, to indicate if the signature position (<FieldName> and <Placeholder>) where found.

Values:

0 = not found in the document

1 = found inside the documentValor 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.

...