Wiki-Quellcode von Quellen

Verstecke letzte Bearbeiter
gru 1.1 1 {{content/}}
2
nlo 7.1 3 {{id name="fig_data_source"/}}
nlo 11.1 4 {{figure image="data_source_de.png"}}Konfigurationsoberfläche zum Anlegen von Datenquellen: (1) Liste existierender Datenquellen, (2) Bereich zum Editieren der selektierten Datenquelle, (3) Einstellungspanel der Datenquelle, (4) Servlet-URL der Datenquelle, um auf diese zugreifen zu können.{{/figure}}
nlo 7.1 5
gru 1.1 6 Die Quellen bzw. Datenquellen werden als Text im Format CSV, JSON oder XML hinterlegt und können über den {{designer case="acc"/}} bzw. das Formular verarbeitet werden.
7
8 Um auch im Skriptbereich per Javaskript auf die Datenquellen Zugriff zu haben, werden alle Datenquellen in eine JSON-Struktur umgewandelt und im Objekt {{code}}XFC_METADATA.urls.datasource_[csv|json|xml]{{/code}} zugänglich gemacht. Die Struktur dieser JSON-Struktur für die verschiedenen Datenquellen ist im jeweiligen Abschnitt erläutert.
9
nlo 10.1 10 == Anlegen einer Datenquelle ==
nlo 9.1 11
nlo 14.1 12 Öffnen Sie das Modul "Daten > Quellen" und klicken Sie auf die Schaltfläche "Neu" {{ficon name="plus-circle-outline"/}} in der Kopfzeile der Liste (siehe Punkt 1 in der [[Abbildung>>||anchor="fig_data_source"]]). Daraufhin werden Sie aufgefordert eine leere Datenquelle anzulegen oder diese aus einer Datei zu importieren. Es können drei Typen von Datenquellen angelegt werden: //XML//, //CSV// und //JSON//.
nlo 9.1 13
nlo 16.1 14 {{lightbox image="data_source_new_de.png" title="Datenquellen können aus Dateien importiert oder neu angelegt werden"/}}
nlo 11.1 15
nlo 14.2 16 === Importieren von Datenquellen aus Dateien ===
17
nlo 15.1 18 Folgende Dateitypen können verwendet werden, um Datenquellen zu importieren:
nlo 14.2 19
nlo 15.1 20 * **XML**: //.xml//
21 * **CSV**: //.csv//, //.xls//, //.xlsx//
22 * **JSON**: //.json//
nlo 14.2 23
nlo 17.1 24 Datenquellen können auch per Drag&Drop importiert werden. Wird eine Datei über die Liste (grüner Bereich gezogen), so wird eine neue Datenquelle vom entsprechenden Typ angelegt (bei Excel-Dateien wird eine Datenquelle pro Arbeitsblatt angelegt). Wird die Datenquelle allerdings über den Editierbereich einer bereits existierenden Datenquelle gezogen, so wird diese aktualisiert. Die Änderungen werden allerdings erst mit einem Klick auf "Speichern" {{icon name="save"/}} übernommen.
25
gru 1.1 26 == CSV ==
27
28 Hier können Sie Datensätze im CSV-Format eingeben.
29
30 * Wählen Sie unter //Typ// die Option //CSV//.
31 * Vergeben Sie einen eindeutigen Namen.
32 * Im Feld //Wert// geben Sie die Daten separiert mit einem Komma ein.
33
nlo 7.1 34 {{figure image="datenquelle_csv_8.png"}}
gru 1.1 35 Die JSON-Struktur der CSV-Datenquelle. Auf diese JSON-Struktur kann dann per Javaskript über {{code}}XFC_METADATA.urls.datasource_[csv|json|xml]{{/code}} zugegriffen werden.
36 {{/figure}}
37
38 === Beispiel für eine CSV-Datenquelle ===
39
40 {{info}}
41 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.
42 {{/info}}
43
44 {{code}}
45 Wert 1.1, Wert 1.2, Wert 1.3, Wert 1.4, ...
46 {{/code}}
47
48 Das Auslesen der Werte im {{designer case="dat"/}} erfolgt über das //Servlet// mit Namen //datenquellecsv//.
49
50 === Servlet-Parameter ===
51
52 {{info}}
53 **Servlet-URL**
54 http(s):~/~/<server>/formcycle/datenquellecsv?mandantName=<Mandant-Name>&name=<Datenquellen-Name>
55 {{/info}}
56
gru 1.3 57 Bei Zugriff aus dem {{designer case="dat"/}} verwenden Sie immer das globale Variablen-Objekt //XFC_METADATA//, siehe hierzu auch [[Globale Designer Variablen>>doc:Main.Formular-Metadaten]]. Beispielsweise kann wie folgt darauf zugegriffen werden: {{code}}XFC_METADATA.urls.datasource_csv{{/code}}.
gru 1.1 58
59 Folgende Parameter sind möglich:
60
61 |=Parametername|=Beschreibung|=Erforderlich
62 |name|Muss dem Namen der CSV-Datenquelle entsprechen.|Ja
63 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben.
64 |projektId|Muss der ID des Formulars entsprechen. Diese Information kann über {{code}}XFC_METADATA.currentProject.id{{/code}} abgerufen werden.|Ja, wenn //mandantName// nicht gegeben.
65 |kopfzeile|Gibt 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
66 |spaltenNamen|Gibt 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
67 |csvTrennzeichen|Gibt das Trennzeichen zwischen den einzelnen Datenzellen an. Wird dieses nicht gesetzt, wird hier standardmäßig ein Komma {{code}},{{/code}} benutzt.|Nein
68 |csvQuote|Das Trennzeichen, mit dem die Werte der Zeilen getrennt sind. Wird dieses nicht gesetzt, wird hier standardmäßig ein Anführungszeichen verwendet {{code}}"{{/code}}.| Nein
69
70 === Anwendungsbeispiel ===
71
72 {{figure image="datenquelle_csv_7.png" width="300"}}
73 Ein Beispiel dafür, wie eine CSV-Datenquelle aussehen kann. Die Spalten werden durch Kommas getrennt.
74 {{/figure}}
75
76 {{code language="csv"}}
77 anrede,vorname,nachname,plz,ort
78 Herr,Max,Mustermann,1000,Musterhausen
79 Frau,Monika,Mustermann,2000,Musterdorf
80 Frau, Luise,Musterfrau,3000,Musterstadt
81
82 {{/code}}
83
84
85
86
gru 1.3 87 Im {{designer case="dat"/}} wird dann folgendes Skript im [[Skriptbereich>>doc:Main.TAB - Script]] verwendet.
gru 1.1 88
89 {{code language="javascript"}}
90 $.getJSON( XFC_METADATA.urls.datasource_csv + "?name=Demo&mandantName=xima.de", function(json) {
91 var obj = json.returnValue[0]
92
93 $('[name=tfAnrede]').val(obj.anrede)
94 $('[name=tfVorname]').val(obj.vorname)
95 $('[name=tfName]').val(obj.nachname)
96 $('[name=tfPLZ]').val(obj.plz)
97 $('[name=tfOrt]').val(obj.ort)
98 })
99 {{/code}}
100
101 {{lightbox image="datenquelle_csv_4.png" width="300"/}}
102
103 Dieses Beispiel als Datenquelle für den {{designer case="acc"/}} [[zum Herunterladen>>attach:beispiel_datenquelle_csv.json||rel="__blank"]].
104
105 === Sonderfall Auswahlelement ===
106
nlo 4.1 107 {{figure image="data_source_csv_designer_de.png"}}
gru 1.1 108 Die Anbindung einer Datenquelle an eine Auswahlelement erfolgt direkt im {{designer case="dat"/}}
109 {{/figure}}
110
gru 1.3 111 Soll die //CSV//-Datenquelle direkt in ein [[Auswahlelement>>doc:Main.Auswahl]] geladen werden, erfolgt dies über die Eigenschaften des Auswahlelements im {{designer case="dat"/}}.
gru 1.1 112
gru 1.3 113 Der Inhalt der CSV-Datenquelle wird folgendermaßen in einem [[Auswahlelement>>doc:Main.Auswahl]] verarbeitet.
gru 1.1 114
115 {{code}}
116 sichtbarer wert, übertragener, wert, optionaler wert, optionaler wert, ...
117 {{/code}}
118
119 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.
120
121 {{code language="javascript"}}
122 $('[name=sel2]').find('option:selected').attr('col0');
123 {{/code}}
124
125 Jeder optionale Wert wird am Auswahlelement als Attribut {{code}}col + Index des optionalen Wert{{/code}} gespeichert. Bei z.B. drei optionalen Werten würde es also //col0//, //col1// und //col2// geben.
126
127 == XML ==
128
gru 1.3 129 Die XML Datenquelle verhält sich analog zur //CSV//-Datenquelle, kann jedoch nicht direkt an ein [[Auswahlelement>>doc:Main.Auswahl]] gebunden werden.
gru 1.1 130
131 {{figure image="datenquelle_xml.png" width="300"}}
132 Die JSON-Struktur der XML-Datenquelle. Auf diese JSON-Struktur kann dann per Javaskript über {{code}}XFC_METADATA.urls.datasource_[csv|json|xml]{{/code}} zugegriffen werden.
133 {{/figure}}
134
135 === Beispiel für eine XML-Datenquelle ===
136
137 {{code language="xml"}}
138 <root>
139 <person>
140 <anrede>
141 Herr
142 </anrede>
143 <vorname>
144 Max
145 </vorname>
146 <nachname>
147 Mustermann
148 </nachname>
149 </person>
150 <person>
151 <anrede>
152 Frau
153 </anrede>
154 <vorname>
155 Monika
156 </vorname>
157 <nachname>
158 Musterfrau
159 </nachname>
160 </person>
161 </root>
162 {{/code}}
163
164
165 === Servlet-Parameter ===
166
167 {{info}}
168 **Servlet-URL**
169 http(s):~/~/<server>/formcycle/datenquellexml?mandantName=<Mandant-Name>&name=<Datenquellen-Name>
170 {{/info}}
171
gru 1.3 172 Bei Zugriff aus dem {{designer case="dat"/}} verwenden Sie immer das globale Variablen-Objekt //XFC_METADATA//, siehe hierzu auch [[Globale Designer Variablen>>doc:Main.Formular-Metadaten]]. Beispielsweise kann wie folgt darauf zugegriffen werden: {{code language="javascript"}}XFC_METADATA.urls.datasource_xml{{/code}}.
gru 1.1 173
174 Folgende Parameter sind möglich:
175
176 |=Parametername|=Beschreibung|=Erforderlich
177 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchem diese Datenquelle erstellt wurde.|Ja
178 |name|Muss dem Namen der CSV-Datenquelle entsprechen.|Ja
179
180 == JSON ==
181
gru 1.3 182 Die //JSON//-Datenquelle verhält sich analog zur //CSV//-Datenquelle, kann jedoch nicht direkt an ein [[Auswahlelement>>doc:Main.Auswahl]] gebunden werden.
gru 1.1 183
184 {{figure image="datenquelle_json.png" width="300"}}
185 Die JSON-Struktur der JSON-Datenquelle. Sie ist identisch mit der JSON-Datenquelle. Auf diese JSON-Struktur kann dann per Javaskript über {{code}}XFC_METADATA.urls.datasource_[csv|json|xml]{{/code}} zugegriffen werden.
186 {{/figure}}
187
188 === Beispiel für eine JSON-Datenquelle ===
189
190 {{code language="json"}}
191 {"person":[
192 {
193 'anrede':'Herr',
194 'vorname':'Max',
195 'nachname':'Mustermann'
196 },
197 {
198 'anrede':'Frau',
199 'vorname':'Monika',
200 'nachname':'Musterfrau'
201 }
202 ]}
203 {{/code}}
204
205 === Servlet-Parameter ===
206
207 {{info}}
208 **Servlet-URL**
209 http(s):~/~/<server>/formcycle/datenquellejson?mandantName=<Mandant-Name>&name=<Datenquellen-Name>
210 {{/info}}
211
gru 1.3 212 Bei Zugriff aus dem {{designer case="dat"/}} verwenden Sie immer das globale Variablenobjekt //XFC_METADATA//, siehe hierzu auch [[Globale Designer Variablen>>doc:Main.Formular-Metadaten]]. Beispielweise kann wie folgt darauf zugegriffen werden: {{code language="javascript"}}XFC_METADATA.urls.datasource_json{{/code}}.
gru 1.1 213
214 Folgende Parameter sind möglich:
215
216 |=Parametername|=Beschreibung|=Erforderlich
217 |mandantName| Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja
218 |name| Muss dem Namen der CSV-Datenquelle entsprechen.|Ja

Navigation

Copyright 2000-2025