Difference between revisions of "LDAP Query Nodes"

From PresenceWiki
Jump to: navigation, search
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
http://www.international-presence.com/images/nodes/ldap.png
+
[[file:ldap.png]]
  
 
The LDAP Query allows presence to integrate with the Lightweight Directory Access Protocol.
 
The LDAP Query allows presence to integrate with the Lightweight Directory Access Protocol.
Line 18: Line 18:
 
The root specifies where the query will start and can be used to improve speed and restrict results.
 
The root specifies where the query will start and can be used to improve speed and restrict results.
  
http://www.international-presence.com/images/docs/ldap/ldapresource.png
+
[[file:ldapresource.png]]
  
 
Once a resource has been created you can check the connection from the test tab.
 
Once a resource has been created you can check the connection from the test tab.
  
http://www.international-presence.com/images/docs/ldap/ldapresourcetest.png
+
[[file:ldapresourcetest.png]]
  
To add an LDAP Query to a Task you can select it from the right click menu or drag the LDAP Query icon from the Data Access list.
+
To add an LDAP Query to a Task you can select it from the right click menu or drag the LDAP Query icon [[file:ldapicon.png]] from the Data Access list.
  
An LDAP Query is an anonymous task element meaning that when you create an LDAP Query it is only created for the current task and so does not get created as a list entry. You can copy an anonymous Task element from one task to another using CTRL+C to copy and CTRL+V to paste. For more information see the section on Anonymous and Specific Task elements.
+
An LDAP Query is an [[Anonymous Nodes|Anonymous Task Element]] meaning that when you create an LDAP Query it is only created for the current task and so does not get created as a list entry. You can copy an anonymous Task element from one task to another using CTRL+C to copy and CTRL+V to paste. For more information see the section on Anonymous and Specific Task elements.
  
When you double click or drop an LDAP Query on a Task the LDAP Query Editor dialog is shown, opening the Info tab:
+
When you double click or drop an LDAP Query on a Task the LDAP Query Editor dialog is shown.
  
Here you can specify the name of the Query and select or create an LDAP resource.
+
On the Info tab you can specify the name of the Query and select or create an LDAP resource.
  
http://www.international-presence.com/images/docs/ldap/ldapinfo.png
+
[[file:ldapinfo.png]]
  
 
On the next tab you can see the tree which will give you an idea of what data is available on this active server.
 
On the next tab you can see the tree which will give you an idea of what data is available on this active server.
  
http://www.international-presence.com/images/docs/ldap/ldaptree.png
+
[[file:ldaptree.png]]
  
 
Notice how the search base is updated as you click on different branches.
 
Notice how the search base is updated as you click on different branches.
  
http://www.international-presence.com/images/docs/ldap/searchbase.png
+
[[file:searchbase.png]]
  
 
The search base is essentially the root for this LDAP Query. It is used later as the starting point for the search. The search will begin on this branch and go through all its sub branches.
 
The search base is essentially the root for this LDAP Query. It is used later as the starting point for the search. The search will begin on this branch and go through all its sub branches.
  
Alternatively you could put the value for the search base into the root value for the resource which would
+
Alternatively you could put the value for the search base into the root value for the resource.
result in the tree displaying only this branch and its sub branches.
+
  
http://www.international-presence.com/images/docs/ldap/ldaproot.png
+
[[file:ldaproot.png]]
  
http://www.international-presence.com/images/docs/ldap/ldaptreeroot.png
+
This would result in the tree displaying only this branch and its sub branches.
 +
 
 +
[[file:ldaptreeroot.png]]
  
 
On the conditions tab you specify what conditions you are interested in.
 
On the conditions tab you specify what conditions you are interested in.
  
http://www.international-presence.com/images/docs/ldap/ldapconditions.png
+
[[file:ldapconditions.png]]
  
 
In the where tab you drag and drop the conditions to make a where clause.
 
In the where tab you drag and drop the conditions to make a where clause.
  
http://www.international-presence.com/images/docs/ldap/ldapwhere.png
+
[[file:ldapwhere.png]]
  
 
It is the actual text in the text tab that is used in the query. Notice how the query is similar to but different from an SQL Query condition. If you edit the text directly then the previous two tabs (conditions and where) will be updated accordingly.
 
It is the actual text in the text tab that is used in the query. Notice how the query is similar to but different from an SQL Query condition. If you edit the text directly then the previous two tabs (conditions and where) will be updated accordingly.
  
http://www.international-presence.com/images/docs/ldap/ldaptext.png
+
[[file:ldaptext.png]]
  
 
In the output tab you can select which fields you would like to be included in the output table.
 
In the output tab you can select which fields you would like to be included in the output table.
  
http://www.international-presence.com/images/docs/ldap/ldapoutput.png
+
[[file:ldapoutput.png]]
  
 
The test allows you to test the query.
 
The test allows you to test the query.
  
http://www.international-presence.com/images/docs/ldap/ldaptest.png
+
[[file:ldaptest.png]]
  
 
After this you can see your results in table form.
 
After this you can see your results in table form.
  
http://www.international-presence.com/images/docs/ldap/ldapresults.png
+
[[file:ldapresults.png]]
  
 
For more on LDAP see:-
 
For more on LDAP see:-
  
 
http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol
 
http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol
 +
 +
== See Also ==
 +
 +
{{DataAccess}}

Latest revision as of 08:54, 20 August 2015

Ldap.png

The LDAP Query allows presence to integrate with the Lightweight Directory Access Protocol.

This can be used for instance to query the Microsoft Active Directory.

The output from the LDAP Query can then be integrated with a Presence Task in exactly the same way as other data sources to provide alerts or data integration facilities.

To start off with you should create an LDAP resource.

The LDAP Resources can be accessed from the Resources Explorer pane on the bottom left of the screen.

Creating a new resource requires username, password, host, root, class and port.

The class is generally com.sun.jndi.ldap.LdapCtxFactory and the port 389 as the standard default.

The root specifies where the query will start and can be used to improve speed and restrict results.

Ldapresource.png

Once a resource has been created you can check the connection from the test tab.

Ldapresourcetest.png

To add an LDAP Query to a Task you can select it from the right click menu or drag the LDAP Query icon Ldapicon.png from the Data Access list.

An LDAP Query is an Anonymous Task Element meaning that when you create an LDAP Query it is only created for the current task and so does not get created as a list entry. You can copy an anonymous Task element from one task to another using CTRL+C to copy and CTRL+V to paste. For more information see the section on Anonymous and Specific Task elements.

When you double click or drop an LDAP Query on a Task the LDAP Query Editor dialog is shown.

On the Info tab you can specify the name of the Query and select or create an LDAP resource.

Ldapinfo.png

On the next tab you can see the tree which will give you an idea of what data is available on this active server.

Ldaptree.png

Notice how the search base is updated as you click on different branches.

Searchbase.png

The search base is essentially the root for this LDAP Query. It is used later as the starting point for the search. The search will begin on this branch and go through all its sub branches.

Alternatively you could put the value for the search base into the root value for the resource.

Ldaproot.png

This would result in the tree displaying only this branch and its sub branches.

Ldaptreeroot.png

On the conditions tab you specify what conditions you are interested in.

Ldapconditions.png

In the where tab you drag and drop the conditions to make a where clause.

Ldapwhere.png

It is the actual text in the text tab that is used in the query. Notice how the query is similar to but different from an SQL Query condition. If you edit the text directly then the previous two tabs (conditions and where) will be updated accordingly.

Ldaptext.png

In the output tab you can select which fields you would like to be included in the output table.

Ldapoutput.png

The test allows you to test the query.

Ldaptest.png

After this you can see your results in table form.

Ldapresults.png

For more on LDAP see:-

http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol

See Also

Task Elements : Data Accesss Task Elements : LDAP Query Nodes

SQL Statement Nodes | Object Monitor Nodes | XML Query Nodes | Mail Scanner Nodes
Web Services Nodes | LDAP Query Nodes | JSON Node | Flat File Parser | Data Table Nodes | Variable Nodes
Transaction Control Nodes | Context XML Nodes


Task Elements | Resources