Versions Compared

Key

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

...

NameDescription
<SignatureGroups> 

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.

<UndefinedGroupName>

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.

<PadSignButton>If the user presses the sign button on the pad, one of the following reactions follows:

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

<SignatureFieldColor>

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


Code Block
languagexml
themeEclipse
titleExample
<SignatureGroups>
	<UndefinedGroupName>3</UndefinedGroupName>
    <PadSignButton>2</PadSignButton>
	<SignatureGroup>
        <SignatureGroupName>GroupA</SignatureGroupName>
        <ShowSignatureTypePopUp>1</ShowSignatureTypePopUp>
        <ShowSignatureTypePopUpDetailsType>
            <SelectionPad>1</SelectionPad>
            <SelectionPhoneTablet>1</SelectionPhoneTablet>
            <SelectionDisplay>0</SelectionDisplay>
        </ShowSignatureTypePopUpDetailsType>
        <SignatureFieldColor>Green</SignatureFieldColor>
   </SignatureGroup>
</SignatureGroups>

  

 

The defined <SignatureGroupName> tag has to be referenced in a <Signature>-, <DigSig>- or  <Static>-tag.

Code Block
languagexml
themeEclipse
titleExample
<DigSig>
      <Mandatory/>
      <Location></Location>
      <PflichtfeldServiceTag/>
      <FieldName>eSigAntragVermittler</FieldName>
      <Reason>Ich stimme dem Inhalt zu.</Reason>
      <Signer>Vermittler</Signer>
      <RectPosY>90</RectPosY>
      <Zoom>Keep</Zoom>
      <SignatureType>2</SignatureType>
      <SignatureGroupName>GroupA</SignatureGroupName>
</DigSig>

<PflichtfeldServiceTag/> Is just an example, that there are other possible tags, which are not observed.


<SignatureType> This optional tag defines the way, how to sign the field.

The available values are:


*0 = stamp data (text/image) without signature
1 = digital stamp (signature with user certificate instead of hand-written signature)
2 = html-signer signature only
3 = pad signature only
4 = app signature only (QR code)
If no signature type is defined, a selection window appears. The signer can choose between following types: StepOver signature pad OR one of our apps OR HTML-signer (with a pen or your finger on your mobile device)


Notice: If <SignatureGroup> with <ShowSignatureTypePopUpDetailsType> is defined, the <SignatureType> value will be ignored!

*<Observer>

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.

*<MandatorySkippable>

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.

*<DueDays><DueWeeks><DueMonths>

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

Find an complete sample in the file: Beispiel_mit_Gruppen.xml

*) These features are only implemented in webSignatureOffice so far. 

...