Input-XML - 6.Ouput Tags

Output XML Parameters

By default the Output XML is based on the Input-XML, this means it also contains the configuration information. The following Options allow you to reduce this to specific information. 

NameDescriptionDescription
<Output>Tag specifies different parameters of output XML with its child tags.
<Format>

Can be either 'Xml' ,'Bzip2File' or 'ZipFile'. Default is 'Xml'.

When Bzip2File or ZipFile is specified as <Format> , output XML is packed into zip file which is later encoded as base64 string.

Additionally, the string is converted to contain only URL-safe caracters (see http://en.wikipedia.org/wiki/Base64#URL_applications) by using <UrlSafe/>.

This string is returned by GetSigResult function of WebSign.

<Include> and <Exclude>

Are optional tags, which are controling the content of the output XML.

Tags listed in <Exclude> will not be saved in output XML.

If <Include> is not empty, only tags listed in <Include> will be stored in output XML.

<ReturnFormFieldValues/>Can be used to get all the formfield name and values in the Return XML, they will be listed under the tag <FormFields>.
Example
<Output>
   <Format>Zip</Format>
   <Include></Include>
   <Exclude>Window,Signatures,SCSPath</Exclude>
</Output>

 

Output values

NameDescription
<Signed> or <geleistet>

Works like a flag indicating, whether particular signature field is signed (value is 1) or not (value is 0).

Signed fields are not offered to the user.

When XML is returned to the calling application, <geleistet> tags contain actual values.

<Found>Is an indicator, that shows whether particualr field has been found in the document (value 1) or not (value 0).
<OpenResult>

Contains result of document open as text string.

The following values are possible:

- Success

- Error

- Security error

- Download error

- Cancelled

<LastMacroNumber>

Contains the number of last pressed macro button (in range from 1 to 10).

If no macro button was pressed, tag value is set to 0 or tag may not be written at all.

<MacroButtonHistory>

Contains the history of macro actions.

This tag without any content should be placed to input XML, otherwise no macro history is reported.

 

MacroButtonHistory contains one or more <Event>...</Event> sections, one section per macro action.

Each section contains <Order> and <ButtonNumber> tags, indicating execution order and button number of a macro action.

In case the closing happens with X followed by the question, if you want to save or not, the values of <ButtonNumber> are 0 for Yes and -1 for no.

<SearchHistory>

Contains the history of all searches.

This tag is only written, when <AddSearchHistory>1</AddSearchHistory> is present,

or "-addsearchhistory" is in command line

or in the SCS/Settings the AddSearchHistory is set.

 

<SearchHistory> contains one or more <Search> ... </Search> sections, one section per search.

Each section contains <Order> indicating the search - order.

 

The section contains <Found> tag,

which is

0, when the <Text> tag is not found,

1 indicating a successful search,

2 for manually edit,

3 indicating a defaulttext replacement,

4 is error occurred

 

 <Text> is the searched text.

 <Used> the finally used text (which could changed by default text or manual input).

<Time> shows search Date/Time.

<Stop> is the search text ,which stops search.

<RetFileInfo/>

When <RetFileInfo/> is added to the Input XML, the Output will be extend with all information from the Ret-File. Sample:

<RetFileInfo>
<Signed>True</Signed>
<FieldsNumber>2</FieldsNumber>
<ManualFieldsNumber>1</ManualFieldsNumber>
<AllFieldsSignedAndSaved>True</AllFieldsSignedAndSaved>
<Field1>
<Valid>True</Valid>
<Signed>True</Signed>
<Saved>True</Saved>
<Manual>False</Manual>
<StartTime>27.09.2018 12:49:40</StartTime>
<StopTime>27.09.2018 12:49:49</StopTime>
<PageNr>1</PageNr>
<Position>106,605,228,676</Position>
<SearchText>Unterschrift Kunde</SearchText>
<DeviceSerial>123456000</DeviceSerial>
</Field1>
<Field2>
<Valid>True</Valid>
<Signed>True</Signed>
<Saved>True</Saved>
<Manual>False</Manual>
<StartTime>27.09.2018 12:49:54</StartTime>
<StopTime>27.09.2018 12:50:00</StopTime>
<PageNr>1</PageNr>
<Position>284,605,405,676</Position>
<SearchText>Unterschrift 123</SearchText>
<DeviceSerial>123456000</DeviceSerial>
</Field2>
</RetFileInfo>