| ... |
... |
@@ -1,33
+1,95 @@ |
| 1 |
1 |
{{content/}} |
| 2 |
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 |
+ |
| 3 |
3 |
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. |
| 4 |
4 |
|
| 5 |
5 |
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. |
| 6 |
6 |
|
| 7 |
|
-== CSV == |
|
10 |
+{{info}} |
|
11 |
+**Servlet-URL** |
|
12 |
+Die Servlet-URL einer Datenquelle wird nach dem Anlegen in der Konfigurationsoberfläche dargestellt (siehe Punkt 4 in der [[Abbildung>>||anchor="fig_data_source"]]) und ist im JS-Objekt {{code}}XFC_METADATA.urls.datasource_[csv|json|xml]{{/code}} verfügbar. |
|
13 |
+{{/info}} |
| 8 |
8 |
|
| 9 |
|
-Hier können Sie Datensätze im CSV-Format eingeben. |
|
15 |
+== Anlegen einer Datenquelle == |
| 10 |
10 |
|
| 11 |
|
-* Wählen Sie unter //Typ// die Option //CSV//. |
| 12 |
|
-* Vergeben Sie einen eindeutigen Namen. |
| 13 |
|
-* Im Feld //Wert// geben Sie die Daten separiert mit einem Komma ein. |
|
17 |
+Ö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//. |
| 14 |
14 |
|
| 15 |
|
-{{figure image="datenquelle_csv_8.png" width="300"}} |
| 16 |
|
-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. |
|
19 |
+{{lightbox image="data_source_new_de.png" title="Datenquellen können aus Dateien importiert oder neu angelegt werden"/}} |
|
20 |
+ |
|
21 |
+Jede Datenquelle benötigt: |
|
22 |
+ |
|
23 |
+* einen eindeutigen Namen (im Einstellungspanel: siehe Punkt 3 in der [[Abbildung>>||anchor="fig_data_source"]]) |
|
24 |
+* die eigentlichen Daten im Editierbereich (siehe Punkt 2 in der [[Abbildung>>||anchor="fig_data_source"]]) |
|
25 |
+ |
|
26 |
+=== Importieren von Datenquellen aus Dateien === |
|
27 |
+ |
|
28 |
+Folgende Dateitypen können verwendet werden, um Datenquellen zu importieren: |
|
29 |
+ |
|
30 |
+* **XML**: //.xml// |
|
31 |
+* **CSV**: //.csv//, //.xls//, //.xlsx// (Excel) |
|
32 |
+* **JSON**: //.json// |
|
33 |
+ |
|
34 |
+{{id name="data_source_import_csv"/}} |
|
35 |
+__CSV-Datenquellen__ |
|
36 |
+ |
|
37 |
+CSV-Datenquellen können aus unterschiedlichen Dateitypen importiert werden: |
|
38 |
+ |
|
39 |
+* //.csv// |
|
40 |
+Es öffnet sich ein Dialog zur Konfiguration des Imports: |
|
41 |
+** **Trennzeichen**: Gibt an welches Trennzeichen in der Datei verwendet wird, um Datenfelder/Spalten voneinander zu trennen (typischerweise: Komma). |
|
42 |
+** **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). |
|
43 |
+** **Beginnen ab Zeile**: Gibt an, ab welcher Zeile die CSV-Datei importiert werden soll. |
|
44 |
+** **Leere Zeilen ignorieren**: Wenn aktiviert werden leere Zeilen beim Import ignoriert. |
|
45 |
+ |
|
46 |
+{{lightbox image="data_source_import_csv_de.png" title="Importdialog für CSV-Dateien"/}} |
|
47 |
+ |
|
48 |
+* //.xls//, //.xlsx// |
|
49 |
+Es öffnet sich ein Dialog zur Konfiguration des Imports: |
|
50 |
+** **Zu importierende Tabellen**: Gibt an welche Arbeitsblätter/Tabellen aus der Datei importiert werden sollen. |
|
51 |
+ |
|
52 |
+{{lightbox image="data_source_import_excel_de.png" title="Importdialog für Excel-Dateien"/}} |
|
53 |
+ |
|
54 |
+__Drag&Drop__ |
|
55 |
+ |
|
56 |
+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. |
|
57 |
+ |
|
58 |
+== CSV == |
|
59 |
+ |
|
60 |
+{{figure image="data_source_csv_servlet_json_comparison.png"}} |
|
61 |
+Die JSON-Struktur einer CSV-Datenquelle. Auf diese JSON-Struktur kann per Javaskcipt über {{code}}XFC_METADATA.urls.datasource_csv{{/code}} zugegriffen werden. (1) Links ist die JSON-Struktur der Datenquelle dargestellt, bei welcher die erste Zeile nicht als Header verwendet wird. Stattdessen werden Header in Form von {{code}}colX{{/code}} verwendet. (2) Rechts ist die Datenquelle zu sehen, wenn die erste Zeile als Header verwendet wird. |
| 17 |
17 |
{{/figure}} |
| 18 |
18 |
|
| 19 |
|
-=== Beispiel für eine CSV-Datenquelle === |
|
64 |
+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. |
| 20 |
20 |
|
| 21 |
|
-{{info}} |
| 22 |
|
-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. |
| 23 |
|
-{{/info}} |
|
66 |
+//Quellcode-Ansicht einer CSV-Datenquelle//: ([[CSV Dateiformat>>https://de.wikipedia.org/wiki/CSV_(Dateiformat)||target="_blank"]]) |
|
67 |
+{{lightbox image="data_source_csv_source.png" title="Quellcode-Ansicht einer CSV-Datenquelle"/}} |
|
68 |
+//Tabellenansicht einer CSV-Datenquelle//: |
|
69 |
+{{lightbox image="data_source_csv_table.png" title="Tabellenansicht einer CSV-Datenquelle"/}} |
| 24 |
24 |
|
| 25 |
|
-{{code}} |
| 26 |
|
-Wert 1.1, Wert 1.2, Wert 1.3, Wert 1.4, ... |
| 27 |
|
-{{/code}} |
|
71 |
+=== Bearbeitung von CSV-Tabellen === |
| 28 |
28 |
|
| 29 |
|
-Das Auslesen der Werte im {{designer case="dat"/}} erfolgt über das //Servlet// mit Namen //datenquellecsv//. |
|
73 |
+Zum Bearbeitung einer CSV-Tabelle befinden sich unterhalb des Editierbereichs eine Reihe von Schaltflächen: |
| 30 |
30 |
|
|
75 |
+* {{ficon name="plus-circle"/}} **Einfügen**: Fügt neue Zeilen oder Spalten relativ zur derzeit selektierten Zelle ein. |
|
76 |
+* {{ficon name="trash-alt2"/}} **Entfernen**: Entfernt die selektierte Zeile oder Spalte oder leert die selektierte Zelle. |
|
77 |
+* {{icon name="upload"/}} **Importieren**: Öffnet den [[Dialog zum Importieren von CSV-Datenquellen>>||anchor="data_source_import_csv"]]. |
|
78 |
+* {{icon name="code"/}} **Quellcode-Ansicht**: Wechselt in die Quellcode-Ansicht. |
|
79 |
+ |
|
80 |
+=== Header von CSV-Datenquellen === |
|
81 |
+ |
|
82 |
+Für CSV-Datenquellen gibt es eine zusätzliche Option in den Datenquelleinstellungen. Die Option **Erste Zeile ist Header** regelt den Zugriff auf die Werte der Datenquelle über das entsprechende Servlet ({{code}}XFC_METADATA.urls.datasource_csv{{/code}}): |
|
83 |
+ |
|
84 |
+* **Aktiviert**: |
|
85 |
+Die Zellen der erste Zeile werden als Schlüssel bzw. {{code}}keys{{/code}} für den Zugriff auf die Werte der jeweiligen Spalte verwendet (siehe [[Anwendungsbeispiel>>||anchor="data_source_csv_example"]]). |
|
86 |
+* **Deaktiviert**: |
|
87 |
+Die Schlüssel bzw. {{code}}keys{{/code}} für den Zugriff auf die Werte der einzelnen Datensätze/Zeilen sind durchnummeriert, beginnend mit {{code}}0{{/code}}. Diese Schlüssel haben folgende Form: {{code}}colX{{/code}}, wobei {{code}}X{{/code}} für den Index der Spalte steht. |
|
88 |
+ |
|
89 |
+{{lightbox image="data_source_csv_settings_de.png" title="Die Option **Erste Zeile ist Header** regelt den Zugriff auf die Werte der Datenquelle über das entsprechende Servlet"/}} |
|
90 |
+ |
|
91 |
+CSV-Datenquellen können im {{designer case="dat"/}} über das //Servlet// mit Namen {{code}}XFC_METADATA.urls.datasource_csv{{/code}} ausgelsen werden. |
|
92 |
+ |
| 31 |
31 |
=== Servlet-Parameter === |
| 32 |
32 |
|
| 33 |
33 |
{{info}} |
| ... |
... |
@@ -48,12
+48,10 @@ |
| 48 |
48 |
|csvTrennzeichen|Gibt das Trennzeichen zwischen den einzelnen Datenzellen an. Wird dieses nicht gesetzt, wird hier standardmäßig ein Komma {{code}},{{/code}} benutzt.|Nein |
| 49 |
49 |
|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 |
| 50 |
50 |
|
|
113 |
+{{id name="data_source_csv_example"/}} |
|
114 |
+ |
| 51 |
51 |
=== Anwendungsbeispiel === |
| 52 |
52 |
|
| 53 |
|
-{{figure image="datenquelle_csv_7.png" width="300"}} |
| 54 |
|
-Ein Beispiel dafür, wie eine CSV-Datenquelle aussehen kann. Die Spalten werden durch Kommas getrennt. |
| 55 |
|
-{{/figure}} |
| 56 |
|
- |
| 57 |
57 |
{{code language="csv"}} |
| 58 |
58 |
anrede,vorname,nachname,plz,ort |
| 59 |
59 |
Herr,Max,Mustermann,1000,Musterhausen |
| ... |
... |
@@ -69,17
+69,17 @@ |
| 69 |
69 |
|
| 70 |
70 |
{{code language="javascript"}} |
| 71 |
71 |
$.getJSON( XFC_METADATA.urls.datasource_csv + "?name=Demo&mandantName=xima.de", function(json) { |
| 72 |
|
- var obj = json.returnValue[0] |
|
132 |
+ var obj = json.returnValue[0]; |
| 73 |
73 |
|
| 74 |
|
- $('[name=tfAnrede]').val(obj.anrede) |
| 75 |
|
- $('[name=tfVorname]').val(obj.vorname) |
| 76 |
|
- $('[name=tfName]').val(obj.nachname) |
| 77 |
|
- $('[name=tfPLZ]').val(obj.plz) |
| 78 |
|
- $('[name=tfOrt]').val(obj.ort) |
| 79 |
|
- }) |
|
134 |
+ $('[name=tfAnrede]').val(obj.anrede); |
|
135 |
+ $('[name=tfVorname]').val(obj.vorname); |
|
136 |
+ $('[name=tfName]').val(obj.nachname); |
|
137 |
+ $('[name=tfPLZ]').val(obj.plz); |
|
138 |
+ $('[name=tfOrt]').val(obj.ort); |
|
139 |
+ }); |
| 80 |
80 |
{{/code}} |
| 81 |
81 |
|
| 82 |
|
-{{lightbox image="datenquelle_csv_4.png" width="300"/}} |
|
142 |
+{{lightbox image="data_source_csv_designer_script_de.png"/}} |
| 83 |
83 |
|
| 84 |
84 |
Dieses Beispiel als Datenquelle für den {{designer case="acc"/}} [[zum Herunterladen>>attach:beispiel_datenquelle_csv.json||rel="__blank"]]. |
| 85 |
85 |
|