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

Navigation

Copyright 2000-2025