Quellen

Zuletzt geändert von superadmin am 24.01.2017

Die Quellen bzw. Datenquellen werden als Text im Format CSV, JSON oder XML hinterlegt und können über den Xima® Formcycle-Designer bzw. das Formular verarbeitet werden.

Um auch im Skriptbereich per Javaskript auf die Datenquellen Zugriff zu haben, werden alle Datenquellen in eine JSON-Struktur umgewandelt und im Objekt XFC_METADATA.urls.datasource_[csv|json|xml] zugänglich gemacht. Die Struktur dieser JSON-Struktur für die verschiedenen Datenquellen ist im jeweiligen Abschnitt erläutert.

CSV

Hier können Sie Datensätze im CSV-Format eingeben.

  • Wählen Sie unter Typ die Option CSV.
  • Vergeben Sie einen eindeutigen Namen.
  • Im Feld Wert geben Sie die Daten separiert mit einem Komma ein.
Die JSON-Struktur der CSV-Datenquelle. Auf diese JSON-Struktur kann dann per Javaskript über XFC_METADATA.urls.datasource_[csv|json|xml] zugegriffen werden.

Beispiel für eine CSV-Datenquelle

Die CSV-Daten werden intern in ein JSON-Objekt umgewandelt, sodass die erste Zeile der CSV-Datei immer die Objektnamen für den späteren Zugriff definiert.
Wert 1.1, Wert 1.2, Wert 1.3, Wert 1.4, ...

Das Auslesen der Werte im Xima® Formcycle-Designer erfolgt über das Servlet mit Namen datenquellecsv.

Servlet-Parameter

Servlet-URL
http(s)://<server>/formcycle/datenquellecsv?mandantName=<Mandant-Name>&name=<Datenquellen-Name>

Bei Zugriff aus dem Xima® Formcycle-Designer verwenden Sie immer das globale Variablen-Objekt XFC_METADATA, siehe hierzu auch Globale Designer Variablen. Beispielsweise kann wie folgt darauf zugegriffen werden: XFC_METADATA.urls.datasource_csv.

Folgende Parameter sind möglich:

ParameternameBeschreibungErforderlich
nameMuss dem Namen der CSV-Datenquelle entsprechen.Ja
mandantNameMuss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.Ja, wenn projektId nicht gegeben.
projektIdMuss der ID des Formulars entsprechen. Diese Information kann über XFC_METADATA.currentProject.id abgerufen werden.Ja, wenn mandantName nicht gegeben.
kopfzeileGibt eine Komma-separierte Liste der Spaltennamen der CSV-Tabelle an. Ist dieser nicht angegeben, so wird hierfür die erste Zeile der CSV-Tabelle verwendet.Nein
spaltenNamenGibt eine kommaseparierte Liste der Spalten an, welche Spalten vom Servlet mit den entsprechenden Werten zurückgeliefert werden. Hierbei werden je nach Verwendung die Namen der Spalten aus dem Parameter kopfzeile oder die Namen der ersten Zeile der CSV-Datenquelle erwartet.Nein
csvTrennzeichenGibt das Trennzeichen zwischen den einzelnen Datenzellen an. Wird dieses nicht gesetzt, wird hier standardmäßig ein Komma , benutzt.Nein
csvQuoteDas Trennzeichen, mit dem die Werte der Zeilen getrennt sind. Wird dieses nicht gesetzt, wird hier standardmäßig ein Anführungszeichen verwendet ". Nein

Anwendungsbeispiel

Ein Beispiel dafür, wie eine CSV-Datenquelle aussehen kann. Die Spalten werden durch Kommas getrennt.
anrede,vorname,nachname,plz,ort
Herr,Max,Mustermann,1000,Musterhausen
Frau,Monika,Mustermann,2000,Musterdorf
Frau, Luise,Musterfrau,3000,Musterstadt

Im Xima® Formcycle-Designer wird dann folgendes Skript im Skriptbereich verwendet.

$.getJSON( XFC_METADATA.urls.datasource_csv + "?name=Demo&mandantName=xima.de", function( json ) {
   var obj = json.returnValue[0]

    $('[name=tfAnrede]').val(obj.anrede)
    $('[name=tfVorname]').val(obj.vorname)
    $('[name=tfName]').val(obj.nachname)
    $('[name=tfPLZ]').val(obj.plz)
    $('[name=tfOrt]').val(obj.ort)
 })

Dieses Beispiel als Datenquelle für den Xima® Formcycle-Designer zum Herunterladen.

Sonderfall Auswahlelement

Die Anbindung einer Datenquelle an eine Auswahlelement erfolgt direkt im Xima® Formcycle-Designer

Soll die CSV-Datenquelle direkt in ein Auswahlelement geladen werden, erfolgt dies über die Eigenschaften des Auswahlelements im Xima® Formcycle-Designer.

Der Inhalt der CSV-Datenquelle wird folgendermaßen in einem Auswahlelement verarbeitet.

sichtbarer wert, übertragener, wert, optionaler wert, optionaler wert, ...

Werden mehr als der sichtbare und übertragene Wert angegeben, also optionale Werte, so können diese im Javaskript über den folgenden jQuery-Selektor abgerufen werden.

$('[name=sel2]').find('option:selected').attr('col0');

Jeder optionale Wert wird am Auswahlelement als Attribut col + Index des optionalen Wert gespeichert. Bei z.B. drei optionalen Werten würde es also col0, col1 und col2 geben.

XML

Die XML Datenquelle verhält sich analog zur CSV-Datenquelle, kann jedoch nicht direkt an ein Auswahlelement gebunden werden.

Die JSON-Struktur der XML-Datenquelle. Auf diese JSON-Struktur kann dann per Javaskript über XFC_METADATA.urls.datasource_[csv|json|xml] zugegriffen werden.

Beispiel für eine XML-Datenquelle

<root>
 <person>
   <anrede>
      Herr
   </anrede>
   <vorname>
      Max
   </vorname>
   <nachname>
      Mustermann
   </nachname>
 </person>
  <person>
   <anrede>
      Frau
   </anrede>
   <vorname>
      Monika
   </vorname>
   <nachname>
      Musterfrau
   </nachname>
 </person>
</root>

Servlet-Parameter

Servlet-URL
http(s)://<server>/formcycle/datenquellexml?mandantName=<Mandant-Name>&name=<Datenquellen-Name>

Bei Zugriff aus dem Xima® Formcycle-Designer verwenden Sie immer das globale Variablen-Objekt XFC_METADATA, siehe hierzu auch Globale Designer Variablen. Beispielsweise kann wie folgt darauf zugegriffen werden: XFC_METADATA.urls.datasource_xml.

Folgende Parameter sind möglich:

ParameternameBeschreibungErforderlich
mandantNameMuss dem Namen des Mandanten entsprechen, unter welchem diese Datenquelle erstellt wurde.Ja
nameMuss dem Namen der CSV-Datenquelle entsprechen.Ja

JSON

Die JSON-Datenquelle verhält sich analog zur CSV-Datenquelle, kann jedoch nicht direkt an ein Auswahlelement gebunden werden.

Die JSON-Struktur der JSON-Datenquelle. Sie ist identisch mit der JSON-Datenquelle. Auf diese JSON-Struktur kann dann per Javaskript über XFC_METADATA.urls.datasource_[csv|json|xml] zugegriffen werden.

Beispiel für eine JSON-Datenquelle

{"person":[
   {
   'anrede':'Herr',
 'vorname':'Max',
   'nachname':'Mustermann'
 },
   {
    'anrede':'Frau',
    'vorname':'Monika',
   'nachname':'Musterfrau'
    }
]}

Servlet-Parameter

Servlet-URL
http(s)://<server>/formcycle/datenquellejson?mandantName=<Mandant-Name>&name=<Datenquellen-Name>

Bei Zugriff aus dem Xima® Formcycle-Designer verwenden Sie immer das globale Variablenobjekt XFC_METADATA, siehe hierzu auch Globale Designer Variablen. Beispielweise kann wie folgt darauf zugegriffen werden: XFC_METADATA.urls.datasource_json.

Folgende Parameter sind möglich:

ParameternameBeschreibungErforderlich
mandantName Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.Ja
name Muss dem Namen der CSV-Datenquelle entsprechen.Ja
Tags:
Erstellt von superadmin am 02.06.2015
  
Copyright 2000-2016