Skip to end of metadata
Go to start of metadata

SSS file structure

There are 2 possible types of signature sets: sets with explicitly (manually) defined fields and intelligent signature sets.

Signature sets with explicitly defined fields.

Below is a sample of signature set file:

[Main]
SignatureFields=1
afterSigning=0
afterCancel=0
Seal=0
EnableBack=0
HideLcdSignButton=0
[Field1]
DefaultSignedBy="Ihr Name..."
DefaultReason="Ich stimme dem Inhalt zu."
Left=74
Top=239
Right=429
Bottom=490
Page=1
MandatoryField=0
Zoom=32
LCDFontSize="8x8"
LCDString3=" Hello, World!"
ConfirmationText="<h1>Do you agree with content?</h1>"
ConfirmationType=3
CPBackground=default
FrameColorOverride=0
FrameColor=255
FrameThicknessOverride=1
FrameThickness=3

Fields and values of the [Main] section:

SignatureFields – defines number of signature fields in the set.

afterSigning – defines action to be performed after signature set is executed.   Possible values:
  0 – do nothing;
  1 – do nothing and disable further manual signing;
  2 – perform Macrobutton1 action;
  3 – perform Macrobutton2 action;
  4 – perform Macrobutton3 action;
  5 – perform Macrobutton4 action.

afterCancel – defines action   to be performed after signature set is cancelled. Possible values: see afterSigning.

Seal – specifies whether to seal the document after signing. Possible values:   0 – do not sign the document, 1 – sign the document.

EnableBack – whether to enable “Back” button after last signature field is   signed or cancelled. Possible values: 0 – disable the button, 1 – enable the   button.

HideLcdSignButton – when signature set file is passed as command-line parameter and document is displayed on LCD of signature device, green button with "Sign" text is displayed in the bottom of LCD if this parameter is set to 0, and is not displayed if this parameter is set to 1.

HideSupportButton – when signature set file is passed as command-line parameter the "Support" - Button in the Dialog-Form is not displayed if this parameter is set to 1. overwrites registry and start parameter.

ShowCancelOptionalSignature - when an optional field is used, an additional "Cancel" Button is switchable. Default is off.

NoScrollSign - value to disable scrolling on monitor while signing . Possible values:   0 – scroll possible, 1 – scrolling disabled.

 

Fields and values of [Field1], [Field2], … [FieldN] sections:

DefaultSignedBy, DefaultReason – specify default name and default reason for   signing that appear in the dialog after signing one field. If eSignatureOffice   is configured not to show the dialog, these values will be used.

Left, Top, Right, Bottom –   specify position of signature field (in points). 1 point = 0.03527777778 centimeters

Page – specify page number. First page has number 1, while the last page has either it's static page number or you can count from the back, which makes the last page "page=-1", the 2nd to last "page=-2" etc.

Timeout – Timeout in Milliseconds after which the signature is Skipped or automatically sealed, depending on the number of BioData-Frames (Strokes on Signature Pad). 0 for no automatic. 

MandatoryField – defines if the field is mandatory for signing or may be skipped.   If the field is configured to be mandatory, and user cancels such a field,   signature set is cancelled and all fields that follow the cancelled field are   skipped too. Possible values: 0 – the field is optional, 1 – the field is mandatory.

ZoomMode – specifies how the page should be zoomed when signing the field.

Zoom – specifies how the page should be zoomed when signing the field. Possible   values: 0 – fit the page to screen, other value – zoom factor.

LCDFontSize – specify LCD font size. Possible values: "8x8", "12x16", "16x16".

LCDString1, LCDString2, etc – allow to define custom text to be shown on LCD   during signing. The topmost line has number 1.

It's possible to specify LCDFontSize and LCDString entries separately for different device types with the help of suffixes.

Possible suffixes are: PlusPadV2, NaturaSign, NaturaSignColour, NaturaSignMobile, NaturaSignFlawless, NaturaSignComfort, NaturaSignClassic, NaturaSignBiometric, NaturaSignMobile15, NaturaSignColorPad2, NaturaSignUniversal, DuraSignBrilliance.

Example:

LCDFontSize="small"
LCDString2="Default text"
LCDFontSize_NaturaSign="large"
LCDString2_NaturaSign="NaturaSign text"
 
When signature set is invoked, 'NaturaSign text' with large font will be displayed if current device is naturaSign V1 or naturaSign V3, and 'Default text' with small font for all other devices.

CPBackground, CPForeground – by default driver downloads background image from device. Then this image is used to show custom LCD text over it. It's possible not to download device image, but use another one. CPBackground=default instructs eSignatureOffice to use the image linked to executable file, not take it from device. CPBackground=C:\image.bmp instructs eSignatureOffice to use the image from appropriate file. Analog function with CPForeground (without Custom Text)

It's possible to specify CPBackground and CPForeground entries separately for different device types with the help of suffixes preceded with an underscore "_"

Possible suffixes are: PlusPadV2, NaturaSign, NaturaSignColour, NaturaSignMobile, NaturaSignFlawless, NaturaSignComfort, NaturaSignClassic, NaturaSignBiometric, NaturaSignMobile15, NaturaSignColorPad2, NaturaSignUniversal, DuraSignBrilliance.

Size of Background-Image must match the corresponding TextSignarea (NaturaSignColour 640x310, NaturaSignFlawless+NaturaSignComfort 480x272, NaturaSignUniversal+DuraSignBrilliance 800x310)

Example: 

CPBackground="C:\TestDateien\g6.bmp"

CPBackground_naturaSignFlawless="C:\TestDateien\g8.bmp"

CPBackground_naturaSignUniversal="C:\TestDateien\g12.bmp"

CPBackground_duraSignBrilliance="C:\TestDateien\g12.bmp"

CPForeground="C:\TestDateien\g6fg.bmp"

CPForeground_naturaSignFlawless="C:\TestDateien\g8fg.bmp"

CPForeground_naturaSignUniversal="C:\TestDateien\g12fg.bmp"

CPForeground_duraSignBrilliance="C:\TestDateien\g12fg.bmp"

 

FrameColorOverride – 0 to use default color (red), 1 to use color specified by FrameColor field.

FrameColor – decimal value of frame color.

FrameThicknessOverride – 0 to use default frame thinkness (1 pixel), 1 to use frame thickness specified by FrameThickness field.

 FrameThickness – frame thickness in pixels.

Intelligent signature sets

Below is a sample of intelligent signature set file:

[Main]
SignatureFields=0
IntelligentFields=1
AfterSigning="0"
AfterCancel="0"
Seal=0
EnableBack=0
SetType="1"
SortOrder=1
ExecutionOrder=0
[IntelligentField1]
DefaultSignedBy="Enter your name..."
DefaultReason="I agree with the document"
MandatoryField=0
LCDFontSize="8x8"
LCDString5=" Hello, World!"
Zoom=100
FieldType=0
TopLeftMark="TL"
BottomRightMark="UB"
TopLeftFontName=""
BottomRightFontName=""
Width=0
Height=0
DisplacementX1=0
DisplacementY1=0
DisplacementX2=0
DisplacementY2=0
DisplacementIndexTL=1
DisplacementIndexBR=9
DisplacementIndexAnchor=1
ConfirmationText="<h1>Do you agree with content?</h1>"
ConfirmationType=3
FrameColorOverride=0
FrameColor=255
FrameThicknessOverride=1
FrameThickness=3

Fields and values of the [Main] section   mostly repeat the fields and value of signature set file for explicitly defined   fields.

SignatureFields – must be 0 for intelligent signature set.

IntelligentFields – number of intelligent field definitions.

AfterSigning, AfterCancel, Seal, EnableBack – see the section for explicitly   defined fields.

HideLcdSignButton – when signature set file is passed as command-line parameter and document is displayed on LCD of signature device, green button with "Sign" text is displayed in the bottom of LCD if this parameter is set to 0, and is not displayed if this parameter is set to 1.

 

HideSupportButton – when signature set file is passed as command-line parameter the "Support" - Button in the Dialog-Form is not displayed if this parameter is set to 1. overwrites registry and start parameter.

SetType – signature set type. Possible values: 0 – signature set with explicitly   defined fields, 1 – intelligent signature set.

SortOrder – specifies fields sort order. Possible values: 0 – order of appearance   in PDF, 1 – from top left to right bottom.

ExecutionOrder – specifies field execution order. Possible values: 0 – ABC   ABC ABC, 1 – AAA BBB CCC, 2 – as sorted.

AfterSigningDisableManualSign, AfterCancelDisableManualSign – specifies if Manual Sign Button is disabled

EnableMultiSign – Allows the signing of already signed Signature, the Signature overlay the older ones. 

ShowCancelOptionalSignature - when an optional field is used, an additional "Cancel" Button is switchable. Default is off.


Fields and values for [IntelligentField1], [IntelligentField2],   … [IntelligentFieldN]  section:

DefaultSignedBy, DefaultReason, DefaultLocation, MandatoryFieldLCDFontSize, ZoomMode, Zoom, LCDStringN, CPBackground, CPForeground

– see the section for explicitly defined fields.

RectPosX, RectPosY are optional. They define position of signature field (rectangle) inside visible area of the page in percent: (0, 0) is upper left corner and (100, 100) is bottom-right corner. 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). 0 for no automatic. 

FieldType – specifies how   signature field size and borders are defined. Possible values: 0 – defined   by two corner symbols; 1 – defined by one corner symbol and size; 2 - defined by Name of already inserted Field in PDF, TopLeftMark is the Name.

TopLeftMark – text for top left field mark.

BottomRightMark – text for bottom right field mark.

TopLeftFontName – font name for top left field mark.

BottomRightFontName –   font name for bottom right field mark.

Width – field width.

Height – field height.

DisplacementX1 – horizontal displacement of top left corner. Can be either   positive or negative.

DisplacementY1 – vertical displacement of top left corner. Can be either positive   or negative.

DisplacementX2 – horizontal displacement of bottom right corner. Can be either   positive or negative.

DisplacementY2 – vertical displacement of bottom right corner. Can be either   positive or negative.

DisplacementIndexTL – position of top left corner relative to top left marker   borders. 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. Visually can be represented as 3x3 matrix:
  1 2 3
  4 5 6
  7 8 9

DisplacementIndexBR – position of bottom right corner relative to bottom right   marker borders. Possible values: see DisplacementIndexTL.

DisplacementIndexAnchor – position of signature field relative to top left   marker borders in case of signature field defined by top left marker and size.   Possible values: see DisplacementIndexTL.

LcdZoom – Zoom

LcdTopLeftX, LcdTopLeftY – position of LCD

Confirmation dialog

It is possible to display a dialog with HTML-formatted text and buttons. For example, this way user may accept some rules, etc. Dialog is shown before signing. If user clicks No or Cancel in the dialog, signing is aborted.

ConfirmationText – HTML-formatted text that will be displayed in a dialog. Whole string is written to a file, then file is opened in browser control.

ConfirmationType – defines buttons to show below ConfirmationText. Possible values are: 0 - don't show the dialog, 1 - OK, 2 - OK and Cancel, 3 - Yes and No.

Stamp Settings

StampText - Text which should be visible inside the Signatur Stamp

StampFontFace - font for the Stamp

StampFontColor - Colour of the Stamp, it´s the dezimal Value (HEX -> DEZ)

StampFontSize - Size of the Colour

Usage of dynamic variables

It´s possible to use variables in the SSS which are set while Startup (SOSigOffice.exe  "Mustermann.pdf" "mustermann.sss" -VAR1="Max Mustermann" -VAR2="123456")

[VAR1],[VAR2]....[VARn] – This variables can be used for Stamp, LCDString, ConfirmationText


 

Size of the signable area on the signature device

It's possible to exactly specify the position and size of the area on the signature device display, which accepts biodata. This way you could reduce the signing area, for example because you don't want your customer to draw his signature over your custom text.

This signing area can be specified either for a broad range of devices or a very narrow range like a single product line. You can add these tags multiple times to a single signature to specify different signable areas for different device groups.


XXXX = Vendor ID (Always 4 hexadeximal digits. If the value is set to "0000", then all values are accepted and no filter is used.)

YYYY = Product ID (Always 4 hexadeximal digits. If the value is set to "0000", then all values are accepted and no filter is used.)

Please refer to Device IDs and display resolutions to find the needed values for your signature device.

TagUsable valuesExplanation
UseSignatureRectangle_XXXXYYYY=0 or 1Set this value to 1 in order to use the signature rectangle resizing feature for the (group of) devices specified by the given Vendor (XXXX) and Product (YYYY) ID.
SignPosX_XXXXYYYY=Positive, whole numbersDetermines the X coordinate of the upper left corner of your signable area on the device in pixel. Specify your (group of) devices with the Vendor (XXXX) and Product (YYYY) ID.
SignPosY_XXXXYYYY=Positive, whole numbersDetermines the Y coordinate of the upper left corner of your signable area on the device in pixel. Specify your (group of) devices with the Vendor (XXXX) and Product (YYYY) ID.
SignPosWidth_XXXXYYYY=Positive, whole numbersDetermines the width of the designated signable area in pixel. Specify your (group of) devices with the Vendor (XXXX) and Product (YYYY) ID.
SignPosHeight_XXXXYYYY=Positive, whole numbersDetermines the height of the designated signable area in pixel. Specify your (group of) devices with the Vendor (XXXX) and Product (YYYY) ID.