Von Version < 3.1 >
bearbeitet von gru
am 14.03.2019, 16:51
Auf Version < 20.1 >
bearbeitet von nlo
am 09.05.2019, 10:03
< >
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.gru
1 +XWiki.nlo
Inhalt
... ... @@ -3,19 +3,22 @@
3 3  Datenbankabfragen verhalten sich ähnlich wie [[Datenquellen>>doc:Sources]] (XML, CSV, JSON), werden jedoch nicht statisch hinterlegt, sondern dynamisch aus einer Datenbank ausgelesen.
4 4  
5 5  {{info}}
6 -Bei der Erstellung einer Abfrage wird eine bereits angelegte [[Verbindung>>doc:Verbindung]] zu einer Datenbank benötigt.
6 +Bei der Erstellung einer Abfrage wird eine bereits angelegte [[Verbindung>>doc:DBConnections]] zu einer Datenbank benötigt.
7 7  {{/info}}
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) Maske 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,30 +26,33 @@
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  
35 +{{table dataTypeAlpha="0" preSort="0-asc"}}
31 31  |=Parametername|=Beschreibung|=Erforderlich
32 32  |name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja
33 33  |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben
34 34  |projektId|Muss der ID des Formulars entsprechen. Diese Information kann über {{code language="javascript"}}XFC_METADATA.currentProject.id{{/code}} abgerufen werden.|Ja, wenn //mandantName// nicht gegeben
35 -|sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.|\\
40 +|sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.|
36 36  |queryParameter|Nur erforderlich, wenn innerhalb der Datenbank-Datenquelle Platzhalter in Form eines Fragezeichens verwendet werden. Ist dies der Fall, so entspricht dieser der komma-separierten Listen der zu verwendeten Parameter. (ab Version 6)|Nein
37 37  |varName|Gibt den Namen des JSON-Response-Objektes an. Ist dieser nicht gesetzt, so besitzt das JSON-Objekt keinen expliziten Namen.|Nein
38 38  |delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein
44 +{{/table}}
39 39  
40 -Bei Zugriff aus einem Formular verwenden Sie bitte immer das globale Variablen-Objekt //XFC_METADATA//, siehe hierzu auch [[Globale Designer Variablen>>doc:Main.Formular-Metadaten]]. 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}}.
41 41  
42 -Ferner empfehlen wir, innerhalb des Formulars die Skriptfunktion [[getDataQuery>>doc:Zusaetzliche_Script-Funktionen.jQuery\.xutil\.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.
43 43  
44 44  Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
45 45  
46 46  == Sonderfall Auswahlelement ==
47 47  
48 -Soll das Ergebnis einer Datenbankabfrage direkt in ein [[Auswahlelement>>doc:Main.Auswahl]] geladen werden, erfolgt dies über die Eigenschaften des Auswahlelements im {{designer case="dat"/}}.
54 +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"/}}.
49 49  
50 50  {{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}}
51 51  
52 -Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Main.Auswahl]] in folgender Reihenfolge verwendet.
58 +Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet.
53 53  
54 54  {{box}}
55 55  Sichtbarer Wert, Übertragener Wert, Optionaler Wert 1, Optionaler Wert 2, ...
... ... @@ -69,21 +69,27 @@
69 69  == Beipiele ==
70 70  
71 71  {{code language="sql"}}
72 -Statement: select name, vorname from tabelle where vorname like(?)
78 +select name, vorname from tabelle where vorname like(?)
73 73  {{/code}}
74 74  
81 +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.
82 +
75 75  Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}}
76 76  
77 77  
78 78  {{code language="sql"}}
79 -Statement: select name, vorname from tabelle where id=?
87 +select name, vorname from tabelle where id=?
80 80  {{/code}}
81 81  
90 +Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben.
91 +
82 82  Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}}
83 83  
84 84  
85 85  {{code language="sql"}}
86 -Statement: select name, vorname from tabelle where ort like(?) AND plz = ?
96 +select name, vorname from tabelle where ort like(?) AND plz = ?
87 87  {{/code}}
88 88  
99 +Diese SQL-Abfrage liefert die Namen aller Personen zurück, die an einem bestimmten Ort wohnen. Der Ort mit Postleitzahl wird über URL-Parameter übergeben.
100 +
89 89  Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/code}}
data_db_query_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +50.7 KB
Inhalt
data_db_query_en.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +49.2 KB
Inhalt
Copyright 2000-2024