Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Die Datenstruktur des XML XMLs von Wizard-Formularen setzt sich aus drei Kern-Elementen zusammen: Gruppen, Variablen und Listen.

Schema

Damit die XML-Daten von anderen Systemen validiert werden können, bieten wir ein XML Schema zum Download an: formData.xsd

Image RemovedImage Added

Allgemeine Informationen

Jede Variable, Gruppe oder Liste besitzt eine ID, welche einen eindeutigen Schlüssel des Feldes kennzeichnet. Dieser Wert entspricht bei einfachen Feldern dem Feldnamen.

Verarbeitungsanweisungen

Es ist zudem möglich, Verarbeitungsanweisung (XML Processing Instructions) für andere Systeme mitzugeben. Diese beginnen mit dem Prefix "<?jax " und sind intern nach dem key="value"-Prinzip aufgebaut. Diese können im Wizard unter "Feldeigenschaften -> Verarbeitung" für Gruppen und Elemente hinterlegt werden: 

Image Removed

Ein erzeugtes XML weist dann folgende Struktur auf:

Image Removed

1) Fingerprint

Im sogenannten Fingerprint stehen generelle Informationen zur Formularinstanz sowie die bei der Formulardefinition als zu Serialisieren angegebenen Eigenschaften, getrennt durch Semikolon und ggf. URL encoded. Folgende Parameter werden immer mitgeliefert:

...

Variablen

2) Processing Instructions: Elemente/Gruppen

Diese Verarbeitungsanweisungen wurden im Wizard hinterlegt, hier auf Feld und Gruppen-Ebene (analog Screenshot: Feldeigenschaften). 

3) Automatisch generierte Processing Instructions

Bei Dateien wird der Name und die die Grösse der Datei (Bytes) automatisch im XML hinzugefügt:

Codeblock
languagexml
linenumberstrue
<var id<var id="dateiupload-VAR_1">
	  <?jax fileNameformat="Grenzmutationsgesuch_13453.pdf" fileSize="62526" TT.MM.JJJJ"?>
	a6f53b10-f897-4613-a3af-7d51d5ea1f80  2020-05-04
</var>

Variablen

Codeblock
languagexml
linenumberstrue
<var id="freitext_xsmall">keine</var>
<var id="freitext_large">Lorem ipsum set amet</var>
<var id="freitext_zwingend">Testfeld Zwingend</var>
<var id="freitext_mehrzeilig">Test Mehrzeilig</var>
<var id="email">asdfasdf@test.ch</var>
<var id="datum">2019-07-03<
<var id="VAR_2">
  <?jax schluessel="wert"?>
  test
</var>
<var id="VAR_3">muster</var>
<var id="VAR_4">example</var>
<var id="VAR_5">inhalt</var>

Einzelne Felder werden mit dem XML-Element <var> gekennzeichnet. Die Felder können eigenständig, als Bestandteil von Listen oder in Gruppen vorkommen und repräsentieren die vom User getätigten Eingaben.

Listen

...

languagexml
linenumberstrue

...

Bei dem Listenelement <list> wird zusätzlich noch die effektive Anzahl Einträge mit dem Attribut "size" mitgegeben. Ebenso sind die zusammengehörigen Felder eines Listeneintrages numerisch gekennzeichnetmit dem Tag "entry" umgeben. Die Verarbeitungsanweisungen werden innerhalb des Listenelements zuoberst gesetzt:

Codeblock
languagexml
linenumberstrue
<list id="listeNr2liste" size="3">
	<?jax listType="singleEntry"?>
	
  <entry>
    <var id="liste_1_name">Müller</var>
    <var id="listeNr2liste_1_name">Martin Müller</var>
	vorname">Stephan</var>
  </entry>
  <entry>
    <var id="listeNr2liste_2_name">Jonas Peterson</var>
	>Diethelm</var>
    <var id="liste_2_vorname">Bernd</var>
  </entry>
  <entry>
    <var id="listeNr2liste_3_name">Michael Rüegger<>August</var>
    <var id="liste_3_vorname">Gabriela</var>
  </entry>
</list>

Gruppen

Codeblock
languagexml
linenumberstrue
<group id<group id="MWSTGRP_1">
	  <?jax global1="true"?>
	  <var id="calcGRP_VAR_anzahl1">2<>Müller</var>
	  <var id="calcGRP_VAR_preis2">42.00<>Martin</var>
	  <var id="calcGRP_VAR_mwst3">8.0<>Teststrasse</var>
</group>

Gruppen sind eine Kombination von Feldern und/oder Listenelementen und werden mit dem Element <group> gekennzeichnet.

pi Elemente

Codeblock
languagexml
linenumberstrue
<group id="GRP_1">
  <pi>
   <key>global1</key>
   <value>true</value> 
  </pi>
</group>

"pi" steht für Processing Instruction und ist für Verarbeitungsinformationen für Drittsysteme gedacht. Diese werden standardmässig nur als eigentliche "XML processing instructions" (<?jax global1="true"?>) serialisiert, können aber auch als eigene Tags mit "key" und "value" ausgegeben werden. Im Beispiel oben wird die Processing Instruction "global1" als Tags "key" und "value" unterhalb des Tags "pi" ausgegeben.