DirXMLScript DTD: token-query element

<token-query> causes a <query> to be performed in the source or destination datastore and returns the resulting <instance>'s.

The datastore to search is specified by datastore.

The base of the query is specified by either <arg-dn> or <arg-association>. If neither are specified, then the base will be the root of the datastore.

The scope of the query is specified by query.

The class of the query is specified by class-name. If omitted the query will look for all classes.

The set of attributes to search for is specified by the <arg-match-attr>'s.

The set of attributes to return is specified by the <arg-string>'s. If no <arg-string> are specified then no attributes will be read. If one of the <arg-string> evaluates to the asterisk character, then all attributes will be read.

If max-result-count is specified, then <query-ex> will be issued instead of a <query> and the results will be returned in batches. When used in the context of a <do-for-each> subsequent batches (if any) will be automatically retrieved.

Example

<token-query class-name="User" datastore="dest" scope="subordinates">
  <arg-dn>
    <token-text>Users/</token-text>
    <token-attr name="OU"/>
  </arg-dn>
  <arg-match-attr name="CN"/>
  <arg-match-attr name="L">
    <arg-value>
      <token-text>Provo</token-text>
    </arg-value>
  </arg-match-attr>
  <arg-string>
    <token-text>Surname</token-text>
  </arg-string>
  <arg-string>
    <token-text>Given Name</token-text>
  </arg-string>
</token-query>

2. Attributes

Attribute Value(s) Default Value

class-name CDATA

class name of target object
supports variable expansion

the class name of the query
supports variable expansion
#IMPLIED

datastore src | dest

the datastore to be queried
dest

max-result-count CDATA

the maximum number of results to return per batch
#IMPLIED

notrace true | false

trueif this element should not be traced during execution of policy
false

scope entry | subordinates | subtree

the scope of the query
subtree

token-query

Example

1. Allowed Content

2. Attributes

3. Content Rule

4. Parent Elements

Attribute	Value(s)	Default Value
class-name	CDATA class name of target object supports variable expansion the class name of the query supports variable expansion	#IMPLIED
datastore	src \| dest the datastore to be queried	dest
max-result-count	CDATA the maximum number of results to return per batch	#IMPLIED
notrace	true \| false trueif this element should not be traced during execution of policy	false
scope	entry \| subordinates \| subtree the scope of the query	subtree