|
Performs
a search on the LDAP server and returns the results in an XML document,
which you can save as process data.
The maximum number of records that the query can return is controlled
by the LDAP server. For example, the default configuration of Microsoft
Active Directory limits the number of records returned in a result
to 1000. If a query is performed on this LDAP server, and more than
1000 records match the query, the result set includes only 1000
records.
Note:
You must configure the LDAP service properties
before using the operations of the LDAP service. (See
LDAP service configuration
.)
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
LDAP and XML Options properties
Properties for specifying details about the query.
LDAP and XML Options
A value that describes the query to perform
and how to format the XML document that contains the query results.
To specify the value, use the LDAP Query Options Editor dialog box.
(See
LDAP Query Options Editor
.)
Connection Settings properties
Properties for specifying an LDAP connection for the LDAP
Query to XML operation. If not provided, or if the Use Global Settings
property is selected, the properties specified by the LDAP service
configuration are used. (See
LDAP service configuration
.)
Use Global Settings
A
boolean
value
that indicates whether the LDAP connection specified by the LDAP
service configuration is used for this operation. If false, the
connection specified in the Connection Settings property group is
used.
Initial Context Factory
A
string
value
that represents the Java class to use as the context factory. This class
is used to create a connection to the LDAP server. The default is
com.sun.jndi.ldap.LdapCtxFactory
,
which is appropriate for most LDAP servers.
Provider URL
A
string
value
that represents the URL to use to connect to the LDAP service. The
format of the value is
ldap://
server name
:
port
-
server name
is the name of the computer that hosts
the LDAP server
-
port
is the communications port that the LDAP service
uses. The default is
389
, which is the standard
port used for LDAP connections.
User Name
A
string
value
that represents the user name of the user account to use to log in
to the LDAP server. The user account must have permission to connect
to the server and read the information in the LDAP directory.
Depending
on the LDAP server, the user name could be a simple user name such as
“myname” or a DN. For example, “CN=myname,CN=users,DC=myorg”.
Password
A
string
value
that represents the password that corresponds with the user name
provided for the Username property.
Other Properties
A
string
value
that represents other properties and their corresponding values that
you can provide to the LDAP server. The value is in the following
format:
property=value;property=value;...
Output XML Document properties
Properties for saving the query results.
Output XML Document
The location to store the XML document that
contains the query results. The data type is
xml
.
|
|
|
