Attributes of the XML Element Attribute

The DTD for config class includes two XML elements called attribute and Attribute . These elements contain the names, types and metadata of the configuration parameters that are required for a new component.

The table lists and explains all the attributes defined for the XML elements attribute and Attribute , specifying the permitted values. Each parameter must be defined with at least a name and a type.

Caution

Note Attributes cannot be combined arbitrarily. For more information about the combinations of attributes that are permitted for the definition of parameters, see Valid Combinations of Attributes

Atrribute	Description	Permitted Values
`type`	The type of the parameter	`Int Float Boolean String Class Enum Ref List`
`name`	Name of the parameter	`String`
`constant`	All the configurables of this config class will have the same constant value for the attribute	`true or false` Default: `false`
`default`	When a new configurable of this config class is instantiated in the config UI, the value will be used as a default	`String`
`mandatory`	If true, the configuration framework only saves a configurable that assigns the attribute a value.	`true or false` Default: `false`
`encrypt`	If this is set to true, the value of the attribute is encrypted when it is saved and the config UI will display only * for the value	`true or false` Default: `false`
`values`	Only valid for attributes of the type `enum` . It lists the possible values of the enumeration	String of comma-separated values. The separator can be redefined`.`
`min`	The minimum value for a numeric field	`Number` Default: Java minimum for the type
`max`	The maximum value for a numeric field	`Number` Default: Java maximum for the type
`minLength`	The minimum number of characters for an attribute of type `String`	`Number` Default: 0
`maxLength`	The maximum number of characters for an attribute of type `String`	`Number`
`listType`	Defines the type of elements for an attribute of type `List` . This is only used with the attribute type `List` .	`Class String Int Float Boolean Ref Configuri`
`refType`	Defines the config class referenced by an attribute of type ref. It can only be used with the attribute ref	String representing the path to a config class, for example:`/utilities/caches/Cache`
`separator`	Defines the separators that can be used to parse the value of an attribute of type list or enum	String containing the separator to use. For example:`", "` represents 2 separatorscomma`','` and space`' '.` Be careful when you chose separators. If a space is defined as a valid separator, your configurable ids should not contain space characters. The CF will escape those characters. Default: `','` (comma, without a space)
`unit`	The unit of the field. This information is displayed in the config UI after the value of the property.	`String`
`subclasses`	Defines whether or not the attribute of type ref should accept subclasses of the config class that it refers to, or only this config class. Only valid for the attribute types ref and list of refs	`true or false` Default: `true`
`exclusive`	Defines whether or not the references to a configurable are exclusive or not. It means that this attribute is of type reference and accepts only values that are not already referenced by another configurable	`true or false` Default: `false`
`hotReload`	Defines whether or not a change to the value of this attribute in a configurable is handled immediately by the application. If set to false, a restart of the application is necessary to apply the change.	`true or false` Default: `false`
`visibleColumn`	Defines whether or not the attribute is displayed in the configurable table in the config UI	`true or false` Default: `true`
`ordered`	Indicates that the list is ordered. As a consequence, the UI will use a specific renderer to display the field and allow the user to order the sequence within the list. The value is only valid for list of references.	`true or false` Default: `false`
`regexp`	Defines a regular expression that is used to check the values entered for this attribute	`String`
`unique`	Indicates whether the same value is permitted several times in the same list	`true or false` Default: `false`