PadConnector Pro XML
- Andy Erd
The 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.
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
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 |
|---|---|---|
| Yes | The document as base64 stream |
| 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. |
|
At least one of the tags | Each signature is a separate tag. The number of signature fields are not limited Nested tags of <Signature> are defined below. |
| Declares a static field, as alternative to intelligent fields declared with Static field properties must be defined by child tags. Possible child tags are <Static>
<Page>1</Page>
<X>3.5</X>
<Y>21.5</Y>
<Height>3.1</Height>
<Width>5</Width>
</Static> | |
| 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 PDF. |
| Yes, as part of | Contains anchor substring, that is used to find signature fields. |
| Yes, as part of | Defines signature field sizes in centimeters. |
| Optional as part of | Defines the position of the anchor point inside rectangle, surrounding the key string. Possible values: 1 - top left 2 – top center 3 – top right 4 – center left 5 – center 6 – center right 7 – bottom left 8 – bottom center 9 – bottom right
Can be represented visually as 3x3 matrix: 1 2 3 4 5 6 7 8 9 (part of |
| Optional as part of | Defines the position of the field relatively to the key string. (part of |
| 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. (part of |
| 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 as part of | Optional tags, that are defining the position and sizing of the signature field (rectangle) on the device display.
(0, 0) is upper left corner and (100, 100) is bottom-right corner.  
The value range is between 10 and 100 percent. |
| 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 values:
Information about the stamp placeholder can be find here |
| 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 signed |
| 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 |
*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:
