Input-XML - 2.Signature fields Definition and Text on LCD

<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> 0 <EnableMultiSign/>

Default behavior, Jumps over already signed Signatures

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

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

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

<Width> and <Height>

or

<Breite> and <Hoehe>

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

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.

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

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

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.

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.

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:

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>

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:

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>

This tag and it’s child tags allow to define text to be shown on signature device’s LCD during signing.

These tags may be omitted, if text is not required. There is may be more than one <Textblock> tag for a single signature field. With the attribute "device", you can define different texts for different signature pads.

There are following possible values:

PlusPadV2, NaturaSign, NaturaSignColour, NaturaSignMobile, NaturaSignFlawless, NaturaSignComfort, NaturaSignClassic, NaturaSignBiometric, NaturaSignMobile15, NaturaSignColorPad2, NaturaSignUniversal, DuraSignBrilliance.

May contain bold (alternative: Fett) and Italic (alternative: Kursiv) substrings, to define bold and italic font style respectively.

Examples of tag content: "Standart", "Bold", "Italic", "BoldItalic" or "Fett, Italic". 

Defines the used color in format R,G,B as decimal between 0 and 255 (f.e. <FontColor>255,0,0</FontColor> for full red colour). If omitted, full black is used as default.

Defines the vertical interval between two lines. If omitted, the default from the selected font is used.

Contains a set of <Text> tags. Each <Text> tag contains one text line.

First line is drawn at <X>, <Y> position, second line is drawn with interval defined by <Interval> or <Zeilenabstand> tag, etc.

Defines one or more signature groups. <SignatureGroups> is optional and has to be set on the same tier like <Signatures>.

Before <SignatureGroup> tags, there are the follwoing global settings possible.

If a signature field is present, which has no signature group name defined, the reaction is defined as follows:

-1 = undefined, use default behaviour

0 = sign field always, even when a group is used

1 = never sign

2 = sign, when all signatures used (no group selected)

3 = Ask User, if signature field should used

The empty tag <UndefinedGroupName/> is defaulted to 2 = sign, when all signatures used (no group selected).

If this tag is not present or erroneous, then the default 2 = sign, when all signatures used (no group selected) is used.

-1 = undefined, use default behavior

0 = Start Signing session with all groups (no group defined)

1 = Start Signing session with the last used group (default no group defined)

2 = display a group selection form, including "no group"

The empty Tag <PadSignButton/> defaults to 0=Start Signing session with all groups (no group defined).

If this tag is not present or erroneuos, then the default 0 = Start Signing session with all groups (no group defined) is used.

If <SignatureGroups> tag is set, there has to be at least one <SignatureGroup> tag following.

The <SignatureGroup> tag includes the Elements

<SignatureGroupName> (string), <ShowSignatureTypePopUp> (int; 1 or 0),

<ShowSignatureTypePopUpDetailsType> (complex type) and <SignatureFieldColor> (string).

<ShowSignatureTypePopUp> either shows a PopUp for every defined signature field with various signature type selections (<ShowSignatureTypePopUp>1</ShowSignatureTypePopUp>)

or not (<ShowSignatureTypePopUp>0</ShowSignatureTypePopUp>).

With the tag <ShowSignatureTypePopUpDetailsType> and it's child tags

<SelectionPad>, <SelectionPhoneTablet>, <SelectionDisplay> (all int's with 1 or 0 values)

the SignatureTypePopUp can be defined showing all or just some of the signature type selections.

If tag <ShowSignatureTypePopUpDetailsType> is not set, all signature type selections will be shown.

Sets the color (and transparency, default transparency is 20%, when not defined) of the signature field, the following are possible

• Given by a regular CSS/HTML color name (see http://www.w3schools.com/colors/colors_hex.asp). Transparency is then 20%.
• direct hex starting with an Sharp sign # followed by 6 hexadezimal digits in the form RRGGBB where R=red portion of Color 00..FF, G=Green, B=Blue. TRansparency is 20%.
• direct hex starting with an Sharp sign # followed by 8 hexadezimal digits in the form AARRGGBB where A=Transparency 0..100, R=red portion of Color 00h..FFh, G=Green, B=Blue.
• rgb(R,G,B) : R,G,B=0..255 decimal, transparency is then 20%
• rgba(R,G,B,A) : R,G,B=0..255, A=0.0..1.0 (fraction) where f.e. 0.2 = 20% Transparency

This optional tag defines an observer for the document.

The observer has to be a registered webSignatureOffice user and will be declared with the login name.

This optional tag defines, if mandatory signature fields are skippable (value 1) or not (value 0).

If no value is set or tag is not defined, mandatory signature fields are not skippable.

Optional signature fields are always skippable.

Tags are defining the expiration of the document.

With setting a value in one of the three tags, the due date will be the date x days / weeks or months after the time of upload.

The relevant value is always the next expected date. For example <DueDays> is set with the value 9 and <DueWeeks> is set with the value 1, the due date will be 7 days later (one week).