8.1 Common XML Constructs

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

name

NMTOKEN

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

#REQUIRED

display-name

CDATA

The string presented to the user to identify the value.

String

display-name-ref

Display names or descriptions that have localization refs.

#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

hide

Boolean

#IMPLIED

mandatory

True or False

If True, the Agent must require the user to supply a value for the CV.

type

String, Boolean, Integer, Real, dn, Enum, List, Passwordref, dn-ref

The value type.

If not present, the type defaults to String.

#IMPLIED

The following elements are contents of a <definition> element and are common to all types except the gcvref type:

Name

Explanation

value

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

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 honored when displaying the description. The description can have a description-ref attribute that is part of the localization scheme used with engine control values (ECVs).