NetIQ Documentation: Identity Manager 4.0.2 DTD Reference - token-unique-name

Remarks

Each <arg-string> element provides a pattern to be used to create a proposed name.

A proposed name is tested by performing a query for that value in the name attribute against the destination data store using the <arg-dn> element or the <arg-association> element as the base of the query and scope as the scope of the query. If the destination data store is the Identity Vault and name is omitted, then a search is performed against the pseudo-attribute “[Entry].rdn”, which represents the RDN of an object without respect to what the naming attribute might be. If the destination data store is the application, then name is required.

A pattern can be tested with and/or without a counter as indicated by counter-use and counter-pattern. When a pattern is tested with a counter, the pattern is tested repeatedly with an appended counter until a name is found that does not return any instances or the counter is exhausted. The counter starting value is specified by counter-start and the counter maximum value is specified in terms of the maximum number of digits as specified by counter-digits. If the number of digits is less than those specified, then the counter is right padded with zeros unless the counter-pad attribute is set to false. The counter is considered exhausted when the counter can no longer be represented by the specified number of digits.

As soon as a proposed name is determined to be unique, the testing of names is stopped and the unique name is returned.

The order of proposed names is tested as follows:

Each pattern is tested in the order specified. If counter-use=“always” and the pattern is one of the patterns indicated by the counter-pattern then the pattern is tested with a counter, otherwise it is tested without a counter.
If no unique name has been found after the patterns have been exhausted and counter-use=“fallback”, then the patterns indicated by the counter-pattern are retried with a counter.

If all specified combinations of patterns and counters are exhausted, then the action specified by the on-unavailable is taken.

Example

<token-unique-name counter-digits="2" counter-pad="true" counter-pattern="first" counter-start="1" counter-use="fallback" name="CN" on-unavailable="error" scope="subtree" test-all-objects="true">
  <arg-string>    <token-upper-case>
      <token-substring length="1" start="0">
        <token-attr name="Given Name"/>
      </token-substring>
      <token-attr name="Surname"/>
    </token-upper-case>
  </arg-string>
  <arg-string>
    <token-upper-case>
      <token-substring length="1" start="0">
        <token-attr name="Given Name"/>
      </token-substring>
      <token-substring length="1" start="0">
        <token-attr name="MI"/>
      </token-substring>
      <token-attr name="Surname"/>
    </token-upper-case>
  </arg-string>
  <arg-string>
    <token-upper-case>
      <token-attr name="Given Name"/>
      <token-attr name="Surname"/>
    </token-upper-case>
  </arg-string>
</token-unique-name>

Allowed Content

Element	Description
arg-association	Association argument.
arg-dn	DN argument.
arg-string	String argument

Attributes

Attribute	Possible Values	Default Value
counter-digits	CDATA Width in digits of counter.	#IMPLIED
counter-pad	true \| false Enable/disable right zero padding of counter.	true
counter-pattern	first \| last \| all Which patterns to use counter with: First: Use counter only with the first pattern. Last: Use counter only with the last pattern. All: Use counter with all patterns.	last
counter-start	CDATA Number to start counter.	1
counter-use	always \| never \| fallbackWhen to use counters: Never: Don't use counters. Always: Always use counters on the patterns indicated by counter-pattern. Fallback: Use counters counter the patterns indicated by counter-pattern only after all patterns have failed without counters.	fallback
name	CDATA Name of attribute to check for uniqueness.	#IMPLIED
notrace	true \| false True if this element should not be traced during execution of the policy.	false
on-unavailable	ignore \| warning \| error \| fatal Action to take if unique name cannot be constructed: Ignore: Ignore and return empty name. Warning: Issue warning and return empty name. Error: Generate error and abort current transaction. Fatal: Generate fatal error and shut down driver.	error
scope	subordinates \| subtree The scope in which to check uniqueness.	subtree
test-all-objects	true \| false The include/exclude object class name in the unique-name query.	false

Content Rule

(( arg-dn | arg-association ) ? , 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.