NetIQ Documentation: Identity Manager 4.0.2 DTD Reference - token-query

Remarks

The data store to search is specified by the data store.

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

The scope of the query is specified by query.

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

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

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

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

Example

<token-query scope="subordinates" class-name="User" datastore="dest">
   <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>

Allowed Content

Element	Description
arg-association	Association argument.
arg-dn	DN argument.
arg-match-attr	Matches the attribute argument.
arg-string	String argument

Attributes

Attribute	Possible Values	Default Value
class-name	CDATA The class name of the query. Supports variable expansion.	#IMPLIED
datastore	src \| dest The data store to be queried.	dest
max-result-count	CDATA The maximum number of results to return per batch.	#IMPLIED
notrace	true \| false True if this element should not be traced during execution of the policy.	false
scope	entry \| subordinates \| subtree The scope of the query.	subtree

Content Rule

(( arg-dn | arg-association ) ? , arg-match-attr * , arg-string * )

Parent Elements

Element	Description
arg-association	Association argument.
arg-component	Component argument.
arg-dn	DN argument.
arg-node-set	Node set argument.
arg-password	Password argument.
arg-string	String argument.
arg-value	Value argument.
token-base64-decode	Decode base64 data into a string.
token-base64-encode	Encode a string into base64 data.
token-convert-time	Convert a data/time from one format to another format.
token-escape-for-dest-dn	Convert a string for use in the destination DN.
token-escape-for-src-dn	Convert a string for use in a source DN.
token-join	Join a node set into a string.
token-lower-case	Convert a string to lowercase.
token-map	Map a string through a mapping table.
token-parse-dn	Parses or converts a DN.
token-replace-all	Replaces all instances of a substring with a string.
token-replace-first	Replaces a single instance of a substring within a string.
token-split	Splits a string into a node set.
token-substring	Substring of a string.
token-upper-case	Converts a string to uppercase.
token-xml-parse	Parses XML.
token-xml-serialize	Serializes XML.