XML Datenstruktur und formData.xsd

Die Datenstruktur des XML 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

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.

Die Anweisungen können für Gruppen, Elemente oder für das ganze Formular hinterlegt werden.  

Werden die eingereichten Formulardaten als JSON an einen Rest-Endpunkt verschickt, so werden die XML Daten generisch in ein JSON umgewandelt. Nähere Informationen dazu sind im nächsten Kapitel beschrieben.

Verarbeitungsanweisungen (Feld- und Gruppenebene)

Für Gruppen und Elemente können die Anweisungen im Wizard unter "Feldeigenschaften -> Verarbeitung" hinterlegt werden.

Verarbeitungsanweisungen (Formularebene)

Möchte man Verarbeitungshinweise für das gesamte Formular hinterlegen, so werden diese auf der Formulardefinition im Bereich "Eigenschaften" hinterlegt. Aktivieren Sie für eine Eigenschaft bestehend aus Wert und Inhalt die Checkbox "Serialisieren", damit diese als Processinginstruction für das gesamte Formular geschrieben wird.

Beispiel-XML mit Processinginstructions

Ein erzeugtes XML weist dann folgende Struktur auf:

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:

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. Der Wert (GUID) ist der eindeutige Schlüssel der hochgeladenen Datei. Mit einem separaten Rest-Endpunkt kann die Datei mit Angabe dieser GUID heruntergeladen werden.

<var id="VAR_fileupload">
  <?jax fileName="LEMFormularBetrieb12_Daten.pdf" fileSize="1104834"?>
  49fec53f-3c74-475a-8025-dc04044247da
</var>

Variablen

<var id="VAR_1">
  <?jax format="TT.MM.JJJJ"?>
  2020-05-04
</var>
<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

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 mit dem Tag "entry" umgeben. Die Verarbeitungsanweisungen werden innerhalb des Listenelements zuoberst gesetzt:

<list id="liste" size="3">
  <entry>
    <var id="liste_1_name">Müller</var>
    <var id="liste_1_vorname">Stephan</var>
  </entry>
  <entry>
    <var id="liste_2_name">Diethelm</var>
    <var id="liste_2_vorname">Bernd</var>
  </entry>
  <entry>
    <var id="liste_3_name">August</var>
    <var id="liste_3_vorname">Gabriela</var>
  </entry>
</list>

Gruppen

<group id="GRP_1">
  <?jax global1="true"?>
  <var id="GRP_VAR_1">Müller</var>
  <var id="GRP_VAR_2">Martin</var>
  <var id="GRP_VAR_3">Teststrasse</var>
</group>

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