Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.gru
	1	+XWiki.nlo

Content

...	...	@@ -1,17 +1,19 @@
1	1	{{content/}}
2	2
3		-LDAP requests work similarly to [[database requests>>doc:Formcycle.UserInterface.Data.DBQueries]] and [[data sources>>doc:Quellen]]. They can be used to retrieve data from an LDAP server dynamically.
	3	+LDAP requests work similarly to [[database requests>>doc:Formcycle.UserInterface.Data.DBQueries]] and [[data sources>>doc:Sources]]. They can be used to retrieve data from an LDAP server dynamically.
4	4	If you need to filter the returned data, you can also add an appropriate LDAP filter.
5	5
6	6	== Creating an LDAP query ==
7	7
8		-{{figure image="067En.png" width="300"/}}
	8	+{{id name="fig_data_ldap_query"/}}
	9	+{{figure image="data_ldap_query_en.png"}}Configuration screen for creating LDAP queries: (1) list of existing LDAP queries, (2) editor for defining the query, (3) settings panel of the query, (4) attribute filters for the query, (5) Generated servlet URL for using the LDAP query, (6) console for testing the query{{/figure}}
9	9
	11	+* Open the module "LDAP queries" and click "New" {{ficon name="plus-circle-outline"/}} in the header of the list (see point 1 in [[figure>>||anchor="fig_data_ldap_query"]]).
10	10	* Provide a name for the LDAP query, and optionally a description.
11		-* Select the LDAP connection to use; either [[client>>doc:MandantenMenue]]'s LDAP connection or another custom [[LDAP connection>>doc:LDAPVerbindung]].
	13	+* Select the LDAP connection to use; either [[client>>doc:Formcycle.UserInterface.Client.WebHome]]'s LDAP connection or another custom [[LDAP connection>>doc:LDAPConnections]].
12	12	* Enter the base DN (distinguished name) for the query. This is the root path for the LDAP search.
13		-* Enter the LDAP query with the //LDAP// filter syntax, [[see here for a tutorial>>url:http://www.selfadsi.de/ldap-filter.htm#FilterDef||rel="__blank"]]). You may also use placeholders (question mark, {{code}}?{{/code}}) that will be replaced with the values from a GET HTTP request for this LDAP query, see below.
14		-* Optionally, enter a list of attributes. The query will return only those attributes, filtered on the server. When no parameters are specified, all attributes will be returned.
	15	+* Enter the LDAP query with the //LDAP// filter syntax in the editor, [[see here for a tutorial>>url:http://www.selfadsi.de/ldap-filter.htm#FilterDef||rel="__blank"]]). You may also use placeholders (question mark, {{code}}?{{/code}}) that will be replaced with the values from a GET HTTP request for this LDAP query (see point 2 in [[figure>>||anchor="fig_data_ldap_query"]]).
	16	+* Optionally, enter a list of attributes. The query will return only those attributes, filtered on the server. When no parameters are specified, all attributes will be returned (see point 4 in [[figure>>||anchor="fig_data_ldap_query"]]).
15	15
16	16	== Using LDAP queries ==
17	17
...	...	@@ -21,6 +21,7 @@
21	21	http://<server>/formcycle/datenabfrageldap
22	22	{{/code}}
23	23
	26	+The servlet URL will be displayed beneath the attribute filters (see point 5 in [[figure>>||anchor="fig_data_ldap_query"]]).
24	24	The following URL parameters are available:
25	25
26	26	{{table dataTypeAlpha="0" preSort="0-asc"}}
...	...	@@ -31,7 +31,7 @@
31	31	|queryParameter|When the LDAP query contains placeholders (question marks, {{code}}?{{/code}}), a list of parameters must be supplied for each placeholder. The items are separated with the delimiter as defined by the URL parameter //delimiter//.|No
32	32	|delimiter|The delimiter for the placeholder values, see //queryParameter//. Defaults to a comma {{code}},{{/code}}|No
33	33
34		-When you want to initiate an LDAP query from a form via JavaScript, use the URL provided by the JavaScript object [[window.XFC_METADATA>>doc:Formular-Metadaten]]. The LDAP query URL can be accessed via {{code language="javascript"}}window.XFC_METADATA.urls.datasource_ldap{{/code}}.
	37	+When you want to initiate an LDAP query from a form via JavaScript, use the URL provided by the JavaScript object [[window.XFC_METADATA>>doc:Main.Formular-Metadaten]]. The LDAP query URL can be accessed via {{code language="javascript"}}window.XFC_METADATA.urls.datasource_ldap{{/code}}.
35	35
36	36	The LDAP queries returns a JSON object that can be parsed with {{code language="javascript"}}JSON.parse(...){{/code}}
37	37