Difference between revisions of "LDAP Query Nodes"

From PresenceWiki
Jump to: navigation, search
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
http://www.international-presence.com/images/nodes/ldap.png
+
[[file:ldap.png]]
  
The Pop Scanner
+
The LDAP Query allows presence to integrate with the Lightweight Directory Access Protocol.
  
The Pop scanner allows integration of incoming emails into a Presence Task.
+
This can be used for instance to query the [http://en.wikipedia.org/wiki/Active_Directory Microsoft Active Directory].
  
The POP Scanner allows you to specify one or more mailboxes to scan either using a static account name or dynamic variables - that is, using account names and details which have been extracted from a database.
+
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.
  
The scanning process then allows you to select either to output all e-mail messages, or to filter based on conditions - much the way as you can query an ODBC/JDBC database or XML file with Presence.
+
To start off with you should create an LDAP resource.
  
The output from the POP Scanner can then be integrated with a Presence Task in exactly the same way as other data sources to provide alerts or data integration facilities.
+
The LDAP Resources can be accessed from the Resources Explorer pane on the bottom left of the screen.
  
Example uses of a Pop Scanner may include but are not limited to the following:
+
Creating a new resource requires '''''username''''', '''''password''''', '''''host''''', '''''root''''', '''''class''''' and '''''port'''''.
  
    * Online Email Client - Use Presence to Pickup and Publish emails to a Browser based system. Coupled with the Send Email Action everything you need is ready to build your own on line Email system.
+
The class is generally '''''com.sun.jndi.ldap.LdapCtxFactory''''' and the port '''''389''''' as the standard default.
    * Spam Filtering - Use Presence to pickup and remove identified (via a SQL or XML query) spam mail. Once emails have been filtered, Presence can then be used to forward the emails that have not been identified as spam to the intended recipients.
+
    * Bi-directional Alerting - A Presence Task could be setup to send an email asking a question, based on the reply a task could start a process, gather more information (remote report requests) or simply store the response in a database.
+
    * Email to SMS forwarding - automatically push the content (or part of the content) of important e-mails out to mobile devices.
+
  
To add a Pop scanner to a Task you can select it from the right click menu or drag the Pop scanner icon from the Data Access list.
+
The root specifies where the query will start and can be used to improve speed and restrict results.
  
A Pop Scanner is an anonymous task element meaning that when you create a POP Scanner it is only created for the current task and does not get created as a list entry in the same way an XML, SQL or Object monitor would. 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.
+
[[file:ldapresource.png]]
  
When you double click or drop a Pop Scanner on a Task the Pop Scanner Editor dialog is shown, opening the Info tab:
+
Once a resource has been created you can check the connection from the test tab.
  
http://www.international-presence.com/images/docs/popscanner/ScreenTaskAdmin_POPScanner_01.png
+
[[file:ldapresourcetest.png]]
  
In the info tab we can provide a Name and Description for this node.
+
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.
Account Details
+
 
 +
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.
 +
 
 +
On the Info tab you can specify the name of the Query and select or create an LDAP resource.
 +
 
 +
[[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.
 +
 
 +
[[file:ldaptree.png]]
 +
 
 +
Notice how the search base is updated as you click on different branches.
 +
 
 +
[[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.
 +
 
 +
Alternatively you could put the value for the search base into the root value for the resource.
 +
 
 +
[[file:ldaproot.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.
 +
 
 +
[[file:ldapconditions.png]]
 +
 
 +
In the where tab you drag and drop the conditions to make a where clause.
 +
 
 +
[[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.
 +
 
 +
[[file:ldaptext.png]]
 +
 
 +
In the output tab you can select which fields you would like to be included in the output table.
 +
 
 +
[[file:ldapoutput.png]]
 +
 
 +
The test allows you to test the query.
 +
 
 +
[[file:ldaptest.png]]
 +
 
 +
After this you can see your results in table form.
 +
 
 +
[[file:ldapresults.png]]
 +
 
 +
For more on LDAP see:-
 +
 
 +
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