| Name | Type | Multiplicity | Description |
|---|---|---|---|
| name |
property QName |
[1,1] | Name of the item. |
| displayName |
property string |
[0,1] | Human readable name. |
| help |
property string |
[0,1] | Help text for the displayed item. |
| documentation |
property string |
[0,1] | Technical documentation for a particular object or construct. |
| displayOrder |
property int |
[0,1] | Order of element. |
| displayHint |
property DisplayHintType |
[0,1] | Enumeration annotation that specifies how the item should be displayed. |
| lifecycleState |
property string |
[0,1] | Lifecycle state of the object. |
Flags: RAM,runtime
Multiplicity: [1,1]
Name of the item.
Flags: RAM,runtime
Multiplicity: [0,1]
Human readable name. This name may be displayed in tools and GUIs
to provide more pleasant user experience, as the XML data type names
or object names may look quite frightening.
The "displayName" should contain a value that is readable for almost any
user. It is never used in the "logic", it is used only for display purposes.
The use of national characters is in "displayName" is fully supported.
DisplayName is reused in several location, but the meaning is still the same.
Flags: RAM,runtime
Multiplicity: [0,1]
Help text for the displayed item. Help text is usually
displayed when the user clicks on help/information icon.
This may be a longer text (several sentences).
This is equivalent to "help" schema annotation.
Flags: RAM,runtime
Multiplicity: [0,1]
Technical documentation for a particular object or construct.
The purpose of this element is to document system configuration and behavior.
The documentation will not be presented to end users. In fact, it will probably
not be presented at all in midPoint user interface. This documentation element
is supposed to be a part of the technical documentation of midPoint deployment.
The tools than generate deployment configuration will look for these elements
and combine them to compiled documentation document.
AsciiDoc formatting is assumed for this element. Any leading or trailing
whitespace is skipped. Indentation equivalent to he indentation of the first
non-blank line of text is also skipped.
Flags: RAM,runtime
Multiplicity: [0,1]
Order of element.
Flags: RAM,runtime,AVals:5
Multiplicity: [0,1]
Enumeration annotation that specifies how the item should be displayed.
Flags: RAM,runtime
Multiplicity: [0,1]
Lifecycle state of the object. This property defines whether the
object represents proposed definition, whether it is active,
deprecated and archived. Only this values is supported.
You can change value to next in order but not back.
See "Object Lifecycle" in the documentation.