definition

The <definition> elements define the actual control values with their data types and other information.

Attributes

The following XML attributes are required or have a default value on a <definition> element and are common to all types:

Attribute

Possible Values

Default Value

attr-name

A non-empty CDATA value.

The name of the eDirectory attribute containing the value. The attribute must be of syntax Distinguished Name.

#IMPLIED

aux-class-name

A non-empty CDATA value.

The name of the eDirectory auxiliary class that attaches the eDirectory attribute to the object containing the CV definition.

#IMPLIED

description

A string presented to the user to explain the value in greater detail than is present in the display-name attribute.The description text might contain line breaks that must be retained when displaying the description.The description can have a description-ref attribute, which is part of the localization scheme used with ECVs.

 

display-name

CDATA

The string presented to the user to identify the value.

"string"

display-name-ref

non-empty CDATA value

Used with ECVs as part of the localization scheme.

#IMPLIED

dn-type

ldap, slash, qualifiedslash, dot, qualifieddot, custom

Specifies the syntax allowed for the value. The Agents must enforce this syntax when the user enters the value.

#IMPLIED

dn-delims

A sequence of at least eight characters that specifies the custom DN format delimiters.

If dn-type = custom, the dn-delims must contain the delimiter set for the custom DN syntax. The delimiter set is at least 8 characters, as follows:

  • The number 0 indicates the untyped names and 1 indicates typed names.

  • The number 0 or 1 indicates to use of not use hex escape unmappable characters in the DN string.

  • Character used for relative DNs

  • Character used to separate RDNs

  • Delimiter in names

  • Value indicator

  • Wildcard character

  • Escape character

Any characters after the eighth character are additional characters that must always be escaped in the DN syntax.

dn-delims is ignored if dn-type is equal to anything other than custom.

#IMPLIED

dn-space

dirxml or application

If the value is dirxml, the Agent should present an object selector button that allows an object to be selected from eDirectory.

#IMPLIED

hide

Boolean

#IMPLIED

item-separator

A non-empty CDATA value.

The value is used as a separator between list item strings when the list value is output in a non-structured location (such as a part of a single string).

For example, if the list items are one, two, and three, and the item-separator value is ";", the following is the unstructured output:

one;two;three

#IMPLIED

multiline

True or False

If True, the Agent should present the value in a multi-line edit field and allow the user to specify line breaks.

The content of the value element must match the following production:

String ::= Char*

The Agent must preserve all characters exactly, including the white space as specified by the user. The Agent serializing the definition XML must therefore specify an xml:space="preserve" attribute on the value element. It can also be necessary to use character entity references for some white space according to the XML rules for parsers:

False

name

NMTOKEN

The configuration value name. Must be unique among all descendant <definition> elements found under the <definitions> element.

#REQUIRED

range-hi

A CDATA value that matches the syntax allowed for the value element content.

Specifies the maximum integer or real value allowed. The Agent must enforce this when the user specifies the value.

#IMPLIED

range-lo

A CDATA value that matches the syntax allowed for the value element content.

Specifies the minimum integer or real value allowed. The Agent must enforce this when the user specifies the value.

#IMPLIED

type

String, Boolean, Integer, Real, Dn, Enum, List, Passwordref, Dn-ref.

Specifies the value type. If the value is not present, the type defaults to string.

#IMPLIED

value

Contains the current value of the configuration value. The actual allowed content is defined by the individual types.

 

Parent Elements

See description.