| ... |
... |
@@ -8,14
+8,17 @@ |
| 8 |
8 |
|
| 9 |
9 |
== Anlegen einer SQL-Abfrage == |
| 10 |
10 |
|
| 11 |
|
-{{figure image="db-abfrage.jpg" width="300"}} |
| 12 |
|
-Anlegen einer SQL-Abfrage in {{formcycle case="dat"/}} |
| 13 |
|
-{{/figure}} |
|
11 |
+{{id name="data_db_query"/}} |
|
12 |
+{{figure image="data_db_query_de.png"}}Die Konfigurationsoberfläche zum Anlegen einer SQL-Abfrage besteht aus vier Teilen: (1) Liste der existierenden Datenbank-Abfragen, (2) Editor zum Definieren der SQL-Abfrage, (3) Einstellungen der Datenbank-Abfrage, (4) Konsole zum Testen der Datenbank-Abfrage.{{/figure}} |
| 14 |
14 |
|
| 15 |
|
-* Vergeben Sie einen eindeutigen Namen. |
| 16 |
|
-* Wählen Sie die Verbindung zur Datenbank |
| 17 |
|
-* Im Feld //Abfrage// geben Sie die SQL-Abfrage ein. |
|
14 |
+* Öffnen Sie das Modul "DB-Abfragen" und klicken Sie auf die Schaltfläche "Neu" {{ficon name="plus-circle-outline"/}} in der Kopzeile der Liste (siehe [[Abbildung>>||anchor="fig_data_db_query"]]). |
|
15 |
+* Für die Datenbank-Abfrage werden folgende Daten benötigt: |
|
16 |
+** **Name**: Ein eindeutiger Name der Datenbank-Abfrage |
|
17 |
+** **Beschreibung**: Eine optionale Beschreibung der Datenbank-Abfrage |
|
18 |
+** **Verbindung**: Die [[DB-Verbindung>>doc:DBConnections]], die verwendet werden soll |
| 18 |
18 |
|
|
20 |
+* Die eigentliche **SQL-Abfrage** wird im Editor in der Mitte einegeben (siehe [[Abbildung>>||anchor="data_db_query"]]). |
|
21 |
+ |
| 19 |
19 |
Das eingegebene Statement wird als //Prepared-Statement// ausgeführt, so dass keine sogenannte //SQL-Injection// moglich ist. Verwenden Sie daher auch keine Hochkommas. Prinzipiell können auch Übergabeparameter verwendet werden. In der Abfrage setzen Sie an die Stelle des Übergabeparameters ein Fragezeichen {{code}}?{{/code}}. |
| 20 |
20 |
|
| 21 |
21 |
== Verwenden der Abfrage == |
| ... |
... |
@@ -26,6
+26,7 @@ |
| 26 |
26 |
http://<server>/formcycle/datenabfragedb |
| 27 |
27 |
{{/code}} |
| 28 |
28 |
|
|
32 |
+Die Servlet-URL wird unterhalb der Einstellungen angezeigt (siehe [[Abbildung>>||anchor="data_db_query"]]). |
| 29 |
29 |
Folgende URL-Parameter sind hierbei möglich: |
| 30 |
30 |
|
| 31 |
31 |
{{table dataTypeAlpha="0" preSort="0-asc"}} |
| ... |
... |
@@ -39,17
+39,44 @@ |
| 39 |
39 |
|delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein |
| 40 |
40 |
{{/table}} |
| 41 |
41 |
|
| 42 |
|
-Bei Zugriff aus einem Formular verwenden Sie bitte immer das globale Variablenobjekt //XFC_METADATA//, siehe hierzu auch die [[formularspezifischen JavaScript-Objekte>>doc:Formcycle.FormDesigner.ScriptMetaAndCssTabs.ScriptTab.FormSpecificJavaScriptObjects]]. In diesem Objekt stehen alle relevanten URLs von {{formcycle case="dat"/}} zur Verfügung, sodass diese Beispielhaft wie folgt ermittelt werden kann: {{code language="javascript"}}XFC_METADATA.urls.datasource_db{{/code}}. |
|
46 |
+Bei Zugriff aus einem Formular verwenden Sie bitte immer das globale Variablenobjekt //XFC_METADATA//, siehe hierzu auch die [[Metadaten>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.FormMetadata]]. In diesem Objekt stehen alle relevanten URLs von {{formcycle case="dat"/}} zur Verfügung, sodass diese Beispielhaft wie folgt ermittelt werden kann: {{code language="javascript"}}XFC_METADATA.urls.datasource_db{{/code}}. |
| 43 |
43 |
|
| 44 |
|
-Ferner empfehlen wir, innerhalb des Formulars die Skriptfunktion [[getDataQuery>>doc:Formcycle.FormDesigner.ScriptMetaAndCssTabs.ScriptTab.AdditionalScriptFunctions.GetDataQuery]] zu verwenden, die das manuelle Aufbauen der Servlet-Abfrage erspart. |
|
48 |
+Ferner empfehlen wir, innerhalb des Formulars die Skriptfunktion [[getDataQuery>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.AdditionalScriptFunctions.GetDataQuery]] zu verwenden, die das manuelle Aufbauen der Servlet-Abfrage erspart. |
| 45 |
45 |
|
| 46 |
46 |
Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden. |
| 47 |
47 |
|
|
52 |
+== Testen der Abfrage == |
|
53 |
+ |
|
54 |
+{{info}} |
|
55 |
+Zum schnellen Testen der Abfrage steht die Tastenkombination {{code}}Strg + Enter{{/code}} zur Verfügung. |
|
56 |
+{{/info}} |
|
57 |
+ |
|
58 |
+Datenbank-Abfragen können direkt in der Konfigurationsoberfläche getestet werden. Hierzu steht eine Testkonsole unterhalb des SQL-Editor zur Verfügung (siehe [[Abbildung>>||anchor="fig_data_db_query"]]). |
|
59 |
+Im Header der Testkonsole befindet sich eine Reihe von Buttons zur Steuerung der Abfrage: |
|
60 |
+ |
|
61 |
+* {{ficon name="database-search"/}}**Abfrage ausführen** |
|
62 |
+Führt die Datenbank-Abfrage aus. Werden //Abfrageparameter// ({{code}}?{{/code}}) verwendet, wird der Nutzer aufgefordert Werte für diese Parameter einzugeben. Ist dies nicht der Fall wird das Ergebnis der Abfrage direkt in der //Tabellenansicht// dargestellt. |
|
63 |
+{{lightbox image="data_db_query_test_de.png" title="Abfrage ausführen"/}} |
|
64 |
+* {{icon name="question"/}}**Abfrageparameter** |
|
65 |
+Maske zum Eingeben von Werten für Abfrageparameter. Diese Option steht nur zur Verfügung, wenn Abfrageparameter ({{code}}?{{/code}}) in der SQL-Abfrage verwendet werden. Die einzelnen Abfrageparameter werden nummeriert im SQL-Query dargestellt. Ein Klick auf "Parameter für Abfrage verwenden" {{ficon name="arrow-right-bold-circle-outline2"/}} führt die Abfrage mit den eingebenen Parametern aus. Das Ergebnis wird in der //Tabellenansicht// dargestellt. |
|
66 |
+{{lightbox image="data_db_query_test_param_de.png" title="Die Paramter der Abfrage werden nummeriert."/}} |
|
67 |
+* {{ficon name="table-large"/}}**Tabellenansicht** |
|
68 |
+Abfrageergebnis in Tabellenform |
|
69 |
+{{lightbox image="data_db_query_test_table_de.png" title="Abfrageergebnis in Tabellenform"/}} |
|
70 |
+* {{icon name="code"/}}**Quellcodeansicht** |
|
71 |
+Abfrageergebnis im JSON-Format |
|
72 |
+{{lightbox image="data_db_query_test_code_de.png" title="Abfrageergebnis im JSON-Format"/}} |
|
73 |
+* {{icon name="Terminal"/}}**Generiertes SQL** |
|
74 |
+Zeigt das generierte SQL-Statement mit eingefügten Parameterwerten |
|
75 |
+{{lightbox image="data_db_query_test_sql_de.png" title="Zeigt den generierten SQL-Query mit eingefügten Parameterwerten"/}} |
|
76 |
+ |
| 48 |
48 |
== Sonderfall Auswahlelement == |
| 49 |
49 |
|
| 50 |
50 |
Soll das Ergebnis einer Datenbankabfrage direkt in ein [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] geladen werden, erfolgt dies über die Eigenschaften des Auswahlelements im {{designer case="dat"/}}. |
| 51 |
51 |
|
| 52 |
|
-{{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}} |
|
81 |
+{{figure image="data_db_query_designer_de.png"}} |
|
82 |
+Verwenden des Ergebnises einer Datenbankabfrage als Auswahlelement im {{designer case="dat"/}}. |
|
83 |
+{{/figure}} |
| 53 |
53 |
|
| 54 |
54 |
Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet. |
| 55 |
55 |
|
| ... |
... |
@@ -67,7
+67,6 @@ |
| 67 |
67 |
$('[name=sel2]').find('option:selected').attr('col2') // Selektiert die Aktive Option des Auswahlelements mit Name 'sel2' und liefert den ersten optionalen Wert zurück. |
| 68 |
68 |
{{/code}} |
| 69 |
69 |
|
| 70 |
|
- |
| 71 |
71 |
== Beipiele == |
| 72 |
72 |
|
| 73 |
73 |
{{code language="sql"}} |
| ... |
... |
@@ -74,7
+74,7 @@ |
| 74 |
74 |
select name, vorname from tabelle where vorname like(?) |
| 75 |
75 |
{{/code}} |
| 76 |
76 |
|
| 77 |
|
-Diese SQL-Abfrage liefert die Namen aller Personen zurück, die einen bestimmten Vornamen haben. Nach welchem Vornamen gesucht werden soll, kann über einen URL-Parameter angegeben werden. |
|
107 |
+Diese SQL-Abfrage liefert die Namen aller Personen zurück, die einen bestimmten Vornamen haben. Nach welchem Vornamen gesucht werden soll, kann über einen URL-Parameter angegeben werden. |
| 78 |
78 |
|
| 79 |
79 |
Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}} |
| 80 |
80 |
|