complexType XmlLdapQuerySource

diagram |
namespace | http://base.api.de.bpm.tibco.com
type | extension of XmlLdapSource
properties |
base | XmlLdapSource
children | attribute-mapping
used by |
element | XmlContainer/primary-ldap
complexType | XmlSecondaryLdapQuerySource
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-alias | xs:string | required |  |  |
documentation
The name (or alias) by which a configured LDAP connection shared resource is identified. LDAP connection shared resource are named with the prefix "ldap/de/" in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the "ldap/de/" prefix. An LDAP container can contain only one instance of an LDAP source for any alias.
resource-name-attributes | xs:string | optional |  |  |
documentation
(Optional) A space-separated list of named LDAP attributes, whose values will be concatenated to generate a default display name for resources derived from entries in this LDAP source. When an LDAP container contains one or more secondary LDAP sources, and those LDAP sources also provide resource-name-attributes, those of the first entry encountered will be used.
base-dn | xs:string | optional |  |  |
documentation
(Optional) Provides an additional base DN that will be used to restrict the scope of the LDAP query. This base DN is relative to, and in additon, to any base DN specified in the URL of the LDAP connection shared resource identified by the ldap-alias.
ldap-query | xs:string | required |  |  |
documentation
LDAP query expression used to identify the entries to be returned from this LDAP source.
search-scope | XmlLdapSearchScope | optional |  |  |
documentation
The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.
annotation |
documentation
Definition of an LDAP Source entry (identified by the LDAP alias) in an LDAP container. This class of LDAP Source is used to locate candidate entries using an LDAP Query, and optional base-dn.
source | <xs:complexType name="XmlLdapQuerySource"> <xs:annotation> <xs:documentation>Definition of an LDAP Source entry (identified by the LDAP alias) in an LDAP container. This class of LDAP Source is used to locate candidate entries using an LDAP Query, and optional base-dn.</xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="XmlLdapSource"> <xs:attribute name="base-dn" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>(Optional) Provides an additional base DN that will be used to restrict the scope of the LDAP query. This base DN is relative to, and in additon, to any base DN specified in the URL of the LDAP connection shared resource identified by the ldap-alias.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ldap-query" type="xs:string" use="required"> <xs:annotation> <xs:documentation>LDAP query expression used to identify the entries to be returned from this LDAP source.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="search-scope" type="XmlLdapSearchScope" use="optional"> <xs:annotation> <xs:documentation>The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType>

attribute XmlLdapQuerySource/@base-dn

type | xs:string
properties |
use | optional
annotation |
documentation
(Optional) Provides an additional base DN that will be used to restrict the scope of the LDAP query. This base DN is relative to, and in additon, to any base DN specified in the URL of the LDAP connection shared resource identified by the ldap-alias.
source | <xs:attribute name="base-dn" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>(Optional) Provides an additional base DN that will be used to restrict the scope of the LDAP query. This base DN is relative to, and in additon, to any base DN specified in the URL of the LDAP connection shared resource identified by the ldap-alias.</xs:documentation> </xs:annotation> </xs:attribute>

attribute XmlLdapQuerySource/@ldap-query

type | xs:string
properties |
use | required
annotation |
documentation
LDAP query expression used to identify the entries to be returned from this LDAP source.
source | <xs:attribute name="ldap-query" type="xs:string" use="required"> <xs:annotation> <xs:documentation>LDAP query expression used to identify the entries to be returned from this LDAP source.</xs:documentation> </xs:annotation> </xs:attribute>

attribute XmlLdapQuerySource/@search-scope

type | XmlLdapSearchScope
properties |
use | optional
facets |
Kind | Value | Annotation
enumeration | ONELEVEL |
enumeration | SUBTREE |
annotation |
documentation
The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.
source | <xs:attribute name="search-scope" type="XmlLdapSearchScope" use="optional"> <xs:annotation> <xs:documentation>The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.</xs:documentation> </xs:annotation> </xs:attribute>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy