Wiki-Quellcode von LDAP-Abfragen

Zeige letzte Bearbeiter
1 {{content/}}
2
3 LDAP-Abfragen verhalten sich ähnlich wie [[Datenbankabfragen>>doc:Formcycle.UserInterface.Data.DBQueries]] oder [[Datenquellen>>doc:Sources]]. Sie dienen dazu, dynamisch Daten von einem //LDAP//-Server zu ermitteln. Hierbei steht neben der Filterung über eine //LDAP-Query// auch die Einschränkung der Rückgabewerte auf festgelegte Attribute zur Verfügung.
4
5 == LDAP-Abfrage anlegen ==
6
7 {{id name="fig_data_ldap_query"/}}
8 {{figure image="data_ldap_query_de.png"}}Konfigurationsoberfläche zum Anlegen von LDAP-Abfragen: (1) Liste existierender LDAP-Abfragen, (2) Editor zum Definieren der Abfrage, (3) Eigenschaften-Panel der Abfrage, (4) Attributfilter der Abfrage, (5) Generierte Servlet-URL zur Verwendung der Abfrage, (6) Konsole zum Testen der Abfrage{{/figure}}
9
10 * Öffnen Sie das Modul "LDAP-Abfragen" und klicken Sie auf die Schaltfläche "Neu" {{ficon name="plus-circle-outline"/}} in der Kopzeile der Liste (siehe [[Abbildung>>||anchor="fig_data_ldap_query"]]).
11 * Vergeben Sie einen eindeutigen Namen und optional eine Beschreibung.
12 * Aktivieren Sie ggf. die Benutzung der //LDAP//-Verbindung des [[Mandanten>>doc:Formcycle.SystemSettings.UserInterface.Clients]] oder wählen sie eine separate [[//LDAP//-Verbindung>>doc:Formcycle.UserInterface.Data.LDAPConnections]] aus.
13 * Definieren Sie für diese //LDAP//-Abfrage zu verwendende //BaseDN//. Diese dient als Wurzel für die Suche mittels der eigentlichen Filterabfrage.
14 * Definieren Sie die Abfrage in entsprechender //LDAP//-Filtersyntax ([[Tutorial>>url:http://www.selfadsi.de/ldap-filter.htm#FilterDef||rel="__blank"]]). Parameter werden innerhalb des Filters durch {{code language="none"}}?{{/code}} angegeben und durch entsprechende Übergaben ersetzt (Punkt 2 in [[Abbildung>>||anchor="fig_data_ldap_query"]]).
15 * Tragen Sie ggf. die von Ihnen benötigten Attribute in den Attributfilter ein. Die Rückgabe der Abfrage wird anschließend auf diese beschränkt. Wird hier kein Attribut definiert, werden alle Attribute des Such-Ergebnisses zurückgeliefert (Punkt 4 in [[Abbildung>>||anchor="fig_data_ldap_query"]]).
16
17 == Verwendung der Abfrage ==
18
19 Die //LDAP//-Datenabfrage ist innerhalb und außerhalb eines Formulars über das hierfür vorgesehene //Servlet// unter Verwendung der entsprechenden Parameter abrufbar.
20
21 {{code language="none"}}
22 http://<server>/formcycle/datenabfrageldap
23 {{/code}}
24
25 Die Servlet-URL wird unterhalb der Attributfilter angezeigt (siehe Punkt 5 in [[Abbildung>>||anchor="fig_data_ldap_query"]]).
26 Folgende URL-Parameter sind hierbei möglich:
27
28 {{table dataTypeAlpha="0" preSort="0-asc"}}
29 |=Parametername|=Beschreibung|=Erforderlich
30 |name|Muss dem Namen der LDAP-Abfrage entsprechen.|Ja
31 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben
32 |projektId|Muss der ID des Formulars entsprechen. Diese Information kann über XFC_METADATA.currentProject.id abgerufen werden.|Ja, wenn //mandantName// nicht gegeben
33 |delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code language="none"}},{{/code}}.
34
35 Wenn möglich sollte für neue Projekte anstelle der Parameter //delimiter// und //queryParameter// der Parameter //queryParameterValues// verwendet werden, da //delimiter// in einer zukünftigen Version von {{formcycle/}} nicht mehr unterstützt werden wird.|Nein
36 |queryParameterValues|//queryParameterValues// ist nur dann erforderlich, wenn innerhalb der LDAP-Abfrage Platzhalter in Form eines Fragezeichens {{code language="none"}}?{{/code}} verwendet werden. Ist dies der Fall, werden die einzelnen Abfrageparameter hintereinander jeweils als ein eingener Parameter //queryParameterValues// übergegeben, wodurch auch die Verwendung des Parameters //delimiter// entfällt.|Nein
37 {{/table}}
38
39 Bei Zugriff aus einem Formular verwenden Sie bitte immer das globale Variablen-Objekt {{jsdoc page="metadata" name="urls"}}XFC_METADATA.urls{{/jsdoc}}. 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_ldap{{/code}}.
40
41 Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
42
43 == Testen der Abfrage ==
44
45 {{info}}
46 Zum schnellen Testen der Abfrage steht die Tastenkombination {{code language="none"}}Strg + Enter{{/code}} zur Verfügung.
47 {{/info}}
48
49 LDAP-Abfragen können direkt in der Konfigurationsoberfläche getestet werden. Hierzu steht eine Testkonsole unterhalb des Editors zur Verfügung (siehe [[Abbildung>>||anchor="fig_data_ldap_query"]]).
50 Im Header der Testkonsole befindet sich eine Reihe von Buttons zur Steuerung der Abfrage:
51
52 * {{ficon name="database-search"/}}**Abfrage ausführen**
53 Führt die LDAP-Abfrage aus. Werden //Abfrageparameter// ({{code language="none"}}?{{/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 //Quellcodeansicht// dargestellt.{{lightbox image="data_ldap_query_test_de.png" title="Abfrage ausführen"/}}
54 * {{icon name="question"/}}**Abfrageparameter**
55 Maske zum Eingeben von Werten für Abfrageparameter. Diese Option steht nur zur Verfügung, wenn Abfrageparameter ({{code language="none"}}?{{/code}}) in der LDAP-Abfrage verwendet werden. Die einzelnen Abfrageparameter werden nummeriert im 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 //Quellcodeansicht// dargestellt.
56 {{lightbox image="data_ldap_query_test_param_de.png" title="Die Paramter der Abfrage werden nummeriert."/}}
57 Eigentliche Abfrage im Editor:{{lightbox image="data_ldap_query_example.png" title="Beispielabfrage"/}}
58 * {{icon name="code"/}}**Quellcodeansicht**
59 Abfrageergebnis im JSON-Format{{lightbox image="data_ldap_query_test_code_de.png" title="Abfrageergebnis im JSON-Format"/}}
60 * {{icon name="Terminal"/}}**Generierte LDAP-Abfrage**
61 Zeigt das generierte LDAP-Statement mit eingefügten Parameterwerten{{lightbox image="data_ldap_query_test_gen_de.png" title="Zeigt den generierten LDAP-Query mit eingefügten Parameterwerten"/}}
62
63 == Beispiele für Abfragen ==
64
65 Im Folgenden wird gezeigt, wie auf eine LDAP-Abfrage mittels HTTP-Requests zugegriffen werden kann.
66
67 Beispielsweise wurde eine LDAP-Abfrage mit dem Namen //MeinAbfrage// angelegt und folgende Abfrage hinterlegt:
68
69 {{code language="none"}}
70 ((distinguishedName=?,?)
71 {{/code}}
72
73 Es müssen zwei Werte für die beiden Platzhalter (Fragezeichen) übergeben werden. Diese Abfrage kann wie folgt aufgerufen werden.
74
75 {{code language="none"}}
76 http://<server>/formcycle/datenabfrageldap?name=MeineAbfrage&mandantName=MeinMandant&queryParameterValues=Wert,1&queryParameterValues=Wert,2
77 {{/code}}
78
79 Zur Abfrage mittels AJAX aus einem Formular gibt es ein fertige Funktion:
80
81 {{code language="javascript"}}
82 $.xutil.getLdapQuery("MeineAbfrage", ["Wert1", "Wert2"])
83 .then(function(data) {
84 // Rückruf-Funktion, die ausgeführt wird, wenn der Server die Abfrage beanwortet hat
85 // Die Variable data enthält jetzt ein Array mit den Daten
86 console.log(data.length, "Einträge gefunden");
87 })
88 .catch(function(xhr, statusMessage, statusCode) {
89 console.log("Abfrage fehlgeschlagen:", statusMessage, statusCode);
90 // Fehlerbehandlung durchführen...
91 });
92 {{/code}}
93
94 Bei dem obigen Code wurde vor {{formcycle/}} Version 6.6.3 immer das Komma als Trennzeichen für die Query-Parameter verwendet. Wenn bei {{formcycle/}} Versionen vor 6.6.3 ein anderes Trennzeichen verwendet werden soll, muss die Abfrage manuell ausgeführt werden:
95
96 {{code language="javascript"}}
97 function ldapQuery(name, queryParameter, delimiter, callback) {
98 $.ajax({
99 url: XFC_METADATA.urls.dataquery_ldap,
100 method: 'GET',
101 async: true,
102 cache: false,
103 dataType: 'json',
104 data: {
105 name: name,
106 mandantName: XFC_METADATA.currentClient.name,
107 queryParameter: queryParameter,
108 delimiter: delimiter || ','
109 }
110 }).then(callback);
111 }
112
113 ldapQuery("MeineAbfrage", "Wert,1;Wert,2", ";", function(data) {
114 // Zurückgelieferte Daten auswerten...
115 });
116 {{/code}}