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 Wert 1.1, Wert 1.2, Wert 1.3, Wert 1.4, ...
68 {{/code}}
69
70 Das Auslesen der Werte im {{designer case="dat"/}} erfolgt über das //Servlet// mit Namen //datenquellecsv//.
71
72 === Servlet-Parameter ===
73
74 {{info}}
75 **Servlet-URL**
76 http(s):~/~/<server>/formcycle/datenquellecsv?mandantName=<Mandant-Name>&name=<Datenquellen-Name>
77 {{/info}}
78
79 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}}.
80
81 Folgende Parameter sind möglich:
82
83 |=Parametername|=Beschreibung|=Erforderlich
84 |name|Muss dem Namen der CSV-Datenquelle entsprechen.|Ja
85 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben.
86 |projektId|Muss der ID des Formulars entsprechen. Diese Information kann über {{code}}XFC_METADATA.currentProject.id{{/code}} abgerufen werden.|Ja, wenn //mandantName// nicht gegeben.
87 |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
88 |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
89 |csvTrennzeichen|Gibt das Trennzeichen zwischen den einzelnen Datenzellen an. Wird dieses nicht gesetzt, wird hier standardmäßig ein Komma {{code}},{{/code}} benutzt.|Nein
90 |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
91
92 === Anwendungsbeispiel ===
93
94 {{figure image="datenquelle_csv_7.png" width="300"}}
95 Ein Beispiel dafür, wie eine CSV-Datenquelle aussehen kann. Die Spalten werden durch Kommas getrennt.
96 {{/figure}}
97
98 {{code language="csv"}}
99 anrede,vorname,nachname,plz,ort
100 Herr,Max,Mustermann,1000,Musterhausen
101 Frau,Monika,Mustermann,2000,Musterdorf
102 Frau, Luise,Musterfrau,3000,Musterstadt
103
104 {{/code}}
105
106
107
108
109 Im {{designer case="dat"/}} wird dann folgendes Skript im [[Skriptbereich>>doc:Main.TAB - Script]] verwendet.
110
111 {{code language="javascript"}}
112 $.getJSON( XFC_METADATA.urls.datasource_csv + "?name=Demo&mandantName=xima.de", function(json) {
113 var obj = json.returnValue[0]
114
115 $('[name=tfAnrede]').val(obj.anrede)
116 $('[name=tfVorname]').val(obj.vorname)
117 $('[name=tfName]').val(obj.nachname)
118 $('[name=tfPLZ]').val(obj.plz)
119 $('[name=tfOrt]').val(obj.ort)
120 })
121 {{/code}}
122
123 {{lightbox image="datenquelle_csv_4.png" width="300"/}}
124
125 Dieses Beispiel als Datenquelle für den {{designer case="acc"/}} [[zum Herunterladen>>attach:beispiel_datenquelle_csv.json||rel="__blank"]].
126
127 === Sonderfall Auswahlelement ===
128
129 {{figure image="data_source_csv_designer_de.png"}}
130 Die Anbindung einer Datenquelle an eine Auswahlelement erfolgt direkt im {{designer case="dat"/}}
131 {{/figure}}
132
133 Soll die //CSV//-Datenquelle direkt in ein [[Auswahlelement>>doc:Main.Auswahl]] geladen werden, erfolgt dies über die Eigenschaften des Auswahlelements im {{designer case="dat"/}}.
134
135 Der Inhalt der CSV-Datenquelle wird folgendermaßen in einem [[Auswahlelement>>doc:Main.Auswahl]] verarbeitet.
136
137 {{code}}
138 sichtbarer wert, übertragener, wert, optionaler wert, optionaler wert, ...
139 {{/code}}
140
141 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.
142
143 {{code language="javascript"}}
144 $('[name=sel2]').find('option:selected').attr('col0');
145 {{/code}}
146
147 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.
148
149 == XML ==
150
151 Die XML Datenquelle verhält sich analog zur //CSV//-Datenquelle, kann jedoch nicht direkt an ein [[Auswahlelement>>doc:Main.Auswahl]] gebunden werden.
152
153 {{figure image="datenquelle_xml.png" width="300"}}
154 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.
155 {{/figure}}
156
157 === Beispiel für eine XML-Datenquelle ===
158
159 {{code language="xml"}}
160 <root>
161 <person>
162 <anrede>
163 Herr
164 </anrede>
165 <vorname>
166 Max
167 </vorname>
168 <nachname>
169 Mustermann
170 </nachname>
171 </person>
172 <person>
173 <anrede>
174 Frau
175 </anrede>
176 <vorname>
177 Monika
178 </vorname>
179 <nachname>
180 Musterfrau
181 </nachname>
182 </person>
183 </root>
184 {{/code}}
185
186
187 === Servlet-Parameter ===
188
189 {{info}}
190 **Servlet-URL**
191 http(s):~/~/<server>/formcycle/datenquellexml?mandantName=<Mandant-Name>&name=<Datenquellen-Name>
192 {{/info}}
193
194 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}}.
195
196 Folgende Parameter sind möglich:
197
198 |=Parametername|=Beschreibung|=Erforderlich
199 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchem diese Datenquelle erstellt wurde.|Ja
200 |name|Muss dem Namen der CSV-Datenquelle entsprechen.|Ja
201
202 == JSON ==
203
204 Die //JSON//-Datenquelle verhält sich analog zur //CSV//-Datenquelle, kann jedoch nicht direkt an ein [[Auswahlelement>>doc:Main.Auswahl]] gebunden werden.
205
206 {{figure image="datenquelle_json.png" width="300"}}
207 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.
208 {{/figure}}
209
210 === Beispiel für eine JSON-Datenquelle ===
211
212 {{code language="json"}}
213 {"person":[
214 {
215 'anrede':'Herr',
216 'vorname':'Max',
217 'nachname':'Mustermann'
218 },
219 {
220 'anrede':'Frau',
221 'vorname':'Monika',
222 'nachname':'Musterfrau'
223 }
224 ]}
225 {{/code}}
226
227 === Servlet-Parameter ===
228
229 {{info}}
230 **Servlet-URL**
231 http(s):~/~/<server>/formcycle/datenquellejson?mandantName=<Mandant-Name>&name=<Datenquellen-Name>
232 {{/info}}
233
234 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}}.
235
236 Folgende Parameter sind möglich:
237
238 |=Parametername|=Beschreibung|=Erforderlich
239 |mandantName| Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja
240 |name| Muss dem Namen der CSV-Datenquelle entsprechen.|Ja

Navigation

Copyright 2000-2025