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

Navigation

Copyright 2000-2025