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

Navigation

Copyright 2000-2025