Versions Compared

Key

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

...

NameDescription

<Signatures> or <Unterschriften>

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.

<EnableMultiSign> 1 <EnableMultiSign/>Allows the signing of already signed Signature, the Signature overlays the older ones. 

<EnableMultiSign> 0 <EnableMultiSign/>

Default behavior, Jumps over already signed Signatures

(as defined with <signed> or <geleistet> )

<Signature> or <Unterschrift>

Each signature is a separate tag. The number of signature fields are not limited

Nested tags of <Signature> are defined below.

<Static/> or <Statisch/>

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 <Page>,<X>,<Y>. The <Page> tag allows you to set also negative values (-1 for last page, -2 the page before the last page; etc...). If the <Page> tag is set to 0, the signature field will be ignored.

<DigSig/>

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

<FieldName>Contains the name of the Signature field, which is already inside the PDF.
<Placeholder> or <Platzhalter>Contains anchor substring, that is used to find signature fields.

<Width> and <Height>

or

<Breite> and <Hoehe>

Defines signature field sizes in centimeters.
<HtmlSignerWidth>Defines the displayed / zoomed signature field width (in cm) for signatures with HTML signer (and with apps)
<DisplacementTLIndex> or <VersatzOLIndex>

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

<DisplacementBRIndex> or <VersatzURIndex>

Is a counterpart of <DisplacementTLIndex> for bottom-right corner.

Used in conjunction with fields, which size is declared by two corner marks (not possible in XML by now).

<FeldPositionIndex>

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

Possible values are the same as for <VersatzOLIndex>.

It may be helpful to open eSignatureOffice, start intelligent signature set configuration dialog and try different settings for signature Placement, to get a visual representation of different values handling.

<Offset_X> and <Offset_Y>

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.

<Mandatory/> or <Pflichtfeld/>

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

<Zoom> 

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.

<RectPosX> and <RectPosY>

 

Are optional tags, that are defining the position of the signature field (rectangle), inside the visible area of the page in percent:

(0, 0) is upper left corner and (100, 100) is bottom-right corner.

The default value is 50 percent.

<Timeout> 

Timeout in Milliseconds, after which the signature is skipped or automatically sealed, depending on the number of BioData-Frames(Strokes on Signature Pad).

<Timeout>0</Timeout> or

<Timeout/> or

Tag <Timeout> not present for no automatic

<BeforeSignConfirmation> 

Allows to define additional confirmation, that appears before starting a signature.


<Type> Specifies confirmation type. Possible values are Ok, OkCancel and YesNo.

 <Text> Specifies confirmation text, which may be either plain text or HTML document.

<Stamp>

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, 0x0000FF00 is pure green, and 0x000000FF is pure red. 0x00000000 is black and 0x00FFFFFF is white.

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

<Signer>, <Reason> and <Location>Tags can be used to specify signer name, reason for signing and signing location respectively.
<Background>

Can be used to define a background image for naturaSign Colour Pad, when additional text is displayed during signature is taken.


If the background is specified, the text is drawn over a provided background image. The content of the tag can be either a path to the file or base-64 representation of bitmap.

Image must have the size of 640x310 pixels for naturaSign Colour Pad,

480x272 for NaturaSignFlawless+NaturaSignComfort, 800x310 for NaturaSignUniversal+DuraSignBrilliance .

You can select a Background image as default for all signatures, or override per signature.

You can define a Background image for different devices with the attribute "device", where the follwing values are possible:

PlusPadV2, NaturaSign, NaturaSignColour, NaturaSignMobile, NaturaSignFlawless, NaturaSignComfort, NaturaSignClassic, NaturaSignBiometric, NaturaSignMobile15, NaturaSignColorPad2, NaturaSignUniversal,  DuraSignBrilliance, duraSign10.0, duraSignPad4.5

Example:  <Background device="DuraSignBrilliance">c:\eSO-Files\brillilanceabckground.png</Background>

<NoScrollSign/> or <NoScrollSign></NoScrollSign> or <NoScrollSign>1</NoScrollSign>To set no scrolling, while signing inside eSignatureOffice.
<Foreground>

Can be used to define foreground image for naturaSign Colour Pad, when additional text is displayed during signature is taken.


If foreground is specified, the text is drawn over a provided foreground image. The content of the tag can be either a path to the file or a base-64 representation of the bitmap. Image must have the size of 640x310 pixels for naturaSign Colour Pad.

You can select a foreground image as default for all signatures, or override per signature.

You can define a foreground image for different devices with the attribute "device", where the follwing values are possible:

PlusPadV2, NaturaSign, NaturaSignColour, NaturaSignMobile, NaturaSignFlawless, NaturaSignComfort, NaturaSignClassic, NaturaSignBiometric, NaturaSignMobile15, NaturaSignColorPad2, NaturaSignUniversal,  DuraSignBrilliance, duraSign10.0, duraSignPad4.5

Example:  <Foreground device="DuraSignBrilliance">c:\eSO-Files\brillilanceabckground.png</Foreground>

<ShowDocumentOnLCD_BW> for black/white Pads
<ShowDocumentOnLCD_Colour> for Colour pads


Possible values:

0 or Keep or '' (Empty) or <ShowDocumentOnLCD_Colour/> or Tag(s) not present = use global Settings from Administration/Signaturdevice/Display
1 or Custom = Custom Sign Mode (Text on Display, Background-Picture ..)
2 or Document = Sign in Document
3 or Auto = Automatic selection, Custom if LCD Text(s) are defined else Sign in Document (for Colour Devices only)

<ShowCancelOptionalSignature>1

</ShowCancelOptionalSignature> 

When an optional field is used, an additional "Cancel" Button is switchable. Default is off.

Possible Values: 0=no cancel button, 1=cancel button,

if omitted then cancel button off,

<ShowCancelOptionalSignature/> is the same as omitting or value 0.

<EnableRestartSign>1</EnableRestartSign>
Allows to continue break a signature process and enables the Signing Button to continue with unsigned signatures. This tag needs the <ShowCancelOptionalSignature> to enable the Cancel Button. With out the tag, the sign button will stay disabled and it´s not possible to continue the signing process with the same instance.
<PasswordRequired>true or false, defines if the signer of the signature has to enter the password when opening the document. If a password is assigned to the document by default <PasswordRequired> is set to true. It must be explicitly set to false to prohibit the password prompt. The <DocumentPassword> is defined globally. See Input-XML - 4.Additional Tags <DocumentPassword>

...