Wiki-Quellcode von Quellen

Zeige letzte Bearbeiter
1 {{content/}}
2
3 {{id name="fig_data_source"/}}
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}}
5
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
10 == Anlegen einer Datenquelle ==
11
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//.
13
14 {{lightbox image="data_source_new_de.png" title="Datenquellen können aus Dateien importiert oder neu angelegt werden"/}}
15
16 Jede Datenquelle benötigt:
17
18 * einen eindeutigen Namen (im Einstellungspanel: siehe Punkt 3 in der [[Abbildung>>||anchor="fig_data_source"]])
19 * die eigentlichen Daten im Editierbereich (siehe Punkt 2 in der [[Abbildung>>||anchor="fig_data_source"]])
20
21 === Importieren von Datenquellen aus Dateien ===
22
23 Folgende Dateitypen können verwendet werden, um Datenquellen zu importieren:
24
25 * **XML**: //.xml//
26 * **CSV**: //.csv//, //.xls//, //.xlsx// (Excel)
27 * **JSON**: //.json//
28
29 __CSV-Datenquellen__
30
31 CSV-Datenquellen können aus unterschiedlichen Dateitypen importiert werden:
32
33 * //.csv//
34 Es öffnet sich ein Dialog zur Konfiguration des Imports:
35 ** **Trennzeichen**: Gibt an welches Trennzeichen in der Datei verwendet wird, um Datenfelder/Spalten voneinander zu trennen (typischerweise: Komma).
36 ** **Textqualifizierer**: Gibt an welches Feldbegrenzerzeichen in der Datei verwendet wird. Dieses Zeichen wird verwendet, um Sonderzeichen innerhalb der Datenfelder nutzen zu können (z. B. Komma in Dezimalzahlwerten).
37 ** **Beginnen ab Zeile**: Gibt an, ab welcher Zeile die CSV-Datei importiert werden soll.
38 ** **Leere Zeilen ignorieren**: Wenn aktiviert werden leere Zeilen beim Import ignoriert.
39
40 {{lightbox image="data_source_import_csv_de.png" title="Importdialog für CSV-Dateien"/}}
41
42 * //.xls//, //.xlsx//
43 Es öffnet sich ein Dialog zur Konfiguration des Imports:
44 ** **Zu importierende Tabellen**: Gibt an welche Arbeitsblätter/Tabellen aus der Datei importiert werden sollen.
45
46 {{lightbox image="data_source_import_excel_de.png" title="Importdialog für Excel-Dateien"/}}
47
48 __Drag&Drop__
49
50 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.
51
52 == CSV ==
53
54 CSV-Datenquellen können in einer Quellcode-Ansicht oder in einer Tabellenansicht dargestellt werden. Die Ansicht kann mit einem Klick auf die entsprechende Schaltfläche in der Fußzeile unterhalb des Editierbereichs geändert werden.
55
56 {{figure image="data_source_csv_servlet_json.png"}}
57 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.
58 {{/figure}}
59
60 === Beispiel für eine CSV-Datenquelle ===
61
62 {{info}}
63 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.
64 {{/info}}
65
66 {{code}}
67 anrede,vorname,nachname,plz,ort
68 Herr,Max,Mustermann,1000,Musterhausen
69 Frau,Monika,Mustermann,2000,Musterdorf
70 Frau, Luise,Musterfrau,3000,Musterstadt
71 {{/code}}
72
73 Das Auslesen der Werte im {{designer case="dat"/}} erfolgt über das //Servlet// mit Namen //datenquellecsv//.
74
75 === Servlet-Parameter ===
76
77 {{info}}
78 **Servlet-URL**
79 http(s):~/~/<server>/formcycle/datenquellecsv?mandantName=<Mandant-Name>&name=<Datenquellen-Name>
80 {{/info}}
81
82 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}}.
83
84 Folgende Parameter sind möglich:
85
86 |=Parametername|=Beschreibung|=Erforderlich
87 |name|Muss dem Namen der CSV-Datenquelle entsprechen.|Ja
88 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben.
89 |projektId|Muss der ID des Formulars entsprechen. Diese Information kann über {{code}}XFC_METADATA.currentProject.id{{/code}} abgerufen werden.|Ja, wenn //mandantName// nicht gegeben.
90 |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
91 |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
92 |csvTrennzeichen|Gibt das Trennzeichen zwischen den einzelnen Datenzellen an. Wird dieses nicht gesetzt, wird hier standardmäßig ein Komma {{code}},{{/code}} benutzt.|Nein
93 |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
94
95 === Anwendungsbeispiel ===
96
97 {{figure image="datenquelle_csv_7.png" width="300"}}
98 Ein Beispiel dafür, wie eine CSV-Datenquelle aussehen kann. Die Spalten werden durch Kommas getrennt.
99 {{/figure}}
100
101 {{code language="csv"}}
102 anrede,vorname,nachname,plz,ort
103 Herr,Max,Mustermann,1000,Musterhausen
104 Frau,Monika,Mustermann,2000,Musterdorf
105 Frau, Luise,Musterfrau,3000,Musterstadt
106
107 {{/code}}
108
109
110
111
112 Im {{designer case="dat"/}} wird dann folgendes Skript im [[Skriptbereich>>doc:Main.TAB - Script]] verwendet.
113
114 {{code language="javascript"}}
115 $.getJSON( XFC_METADATA.urls.datasource_csv + "?name=Demo&mandantName=xima.de", function(json) {
116 var obj = json.returnValue[0]
117
118 $('[name=tfAnrede]').val(obj.anrede)
119 $('[name=tfVorname]').val(obj.vorname)
120 $('[name=tfName]').val(obj.nachname)
121 $('[name=tfPLZ]').val(obj.plz)
122 $('[name=tfOrt]').val(obj.ort)
123 })
124 {{/code}}
125
126 {{lightbox image="datenquelle_csv_4.png" width="300"/}}
127
128 Dieses Beispiel als Datenquelle für den {{designer case="acc"/}} [[zum Herunterladen>>attach:beispiel_datenquelle_csv.json||rel="__blank"]].
129
130 === Sonderfall Auswahlelement ===
131
132 {{figure image="data_source_csv_designer_de.png"}}
133 Die Anbindung einer Datenquelle an eine Auswahlelement erfolgt direkt im {{designer case="dat"/}}
134 {{/figure}}
135
136 Soll die //CSV//-Datenquelle direkt in ein [[Auswahlelement>>doc:Main.Auswahl]] geladen werden, erfolgt dies über die Eigenschaften des Auswahlelements im {{designer case="dat"/}}.
137
138 Der Inhalt der CSV-Datenquelle wird folgendermaßen in einem [[Auswahlelement>>doc:Main.Auswahl]] verarbeitet.
139
140 {{code}}
141 sichtbarer wert, übertragener, wert, optionaler wert, optionaler wert, ...
142 {{/code}}
143
144 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.
145
146 {{code language="javascript"}}
147 $('[name=sel2]').find('option:selected').attr('col0');
148 {{/code}}
149
150 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.
151
152 == XML ==
153
154 Die XML Datenquelle verhält sich analog zur //CSV//-Datenquelle, kann jedoch nicht direkt an ein [[Auswahlelement>>doc:Main.Auswahl]] gebunden werden.
155
156 {{figure image="datenquelle_xml.png" width="300"}}
157 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.
158 {{/figure}}
159
160 === Beispiel für eine XML-Datenquelle ===
161
162 {{code language="xml"}}
163 <root>
164 <person>
165 <anrede>
166 Herr
167 </anrede>
168 <vorname>
169 Max
170 </vorname>
171 <nachname>
172 Mustermann
173 </nachname>
174 </person>
175 <person>
176 <anrede>
177 Frau
178 </anrede>
179 <vorname>
180 Monika
181 </vorname>
182 <nachname>
183 Musterfrau
184 </nachname>
185 </person>
186 </root>
187 {{/code}}
188
189
190 === Servlet-Parameter ===
191
192 {{info}}
193 **Servlet-URL**
194 http(s):~/~/<server>/formcycle/datenquellexml?mandantName=<Mandant-Name>&name=<Datenquellen-Name>
195 {{/info}}
196
197 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}}.
198
199 Folgende Parameter sind möglich:
200
201 |=Parametername|=Beschreibung|=Erforderlich
202 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchem diese Datenquelle erstellt wurde.|Ja
203 |name|Muss dem Namen der CSV-Datenquelle entsprechen.|Ja
204
205 == JSON ==
206
207 Die //JSON//-Datenquelle verhält sich analog zur //CSV//-Datenquelle, kann jedoch nicht direkt an ein [[Auswahlelement>>doc:Main.Auswahl]] gebunden werden.
208
209 {{figure image="datenquelle_json.png" width="300"}}
210 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.
211 {{/figure}}
212
213 === Beispiel für eine JSON-Datenquelle ===
214
215 {{code language="json"}}
216 {"person":[
217 {
218 'anrede':'Herr',
219 'vorname':'Max',
220 'nachname':'Mustermann'
221 },
222 {
223 'anrede':'Frau',
224 'vorname':'Monika',
225 'nachname':'Musterfrau'
226 }
227 ]}
228 {{/code}}
229
230 === Servlet-Parameter ===
231
232 {{info}}
233 **Servlet-URL**
234 http(s):~/~/<server>/formcycle/datenquellejson?mandantName=<Mandant-Name>&name=<Datenquellen-Name>
235 {{/info}}
236
237 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}}.
238
239 Folgende Parameter sind möglich:
240
241 |=Parametername|=Beschreibung|=Erforderlich
242 |mandantName| Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja
243 |name| Muss dem Namen der CSV-Datenquelle entsprechen.|Ja

Navigation

Copyright 2000-2025