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

Navigation

Copyright 2000-2025