|
name
|
The name of the field as it appears in the object definition.
|
|
display-name
|
The name of the field as it will appear on the MIDM.
|
|
display-order
|
The order in which the field appears in the object on the MIDM.
For example, specify 1 to indicate this
is the first field on the MIDM pages, 2 to
indicate it is the second field, and so on. The display order goes from left
to right,
|
|
max-length
|
The maximum number of characters displayed on the MIDM for the
field.
|
|
gui-type
|
An indicator of the type of display for the field. Specify TextBox for a standard data entry field; MenuList for a field that must be populated by selecting
from a drop-down list; or TextArea for
a long field that requires a scrollbar, such as a comments field.
|
|
value-type
|
The Sun Master Index data type for the data populated in the field. Enter
one of the following values:
-
string - Field contains
a string of characters.
-
date - Field contains a
date value.
-
float - Field contains
a floating point integer.
-
int - Field contains an
integer.
-
char - Field contains a
single character.
-
boolean - Field contains
either “true” or “false”.
|
|
input-mask
|
A mask used by the MIDM to add punctuation to a field. You can
add an input mask to display telephone numbers as “(123)456-7890”
even though no punctuation is entered by the user.
To define an input mask, type a character type for each character in
the field, and place any necessary punctuation between the character types.
For example, the input mask for the above telephone format is “(DDD)DDD-DDDD”.
The following character types are allowed:
-
D - indicates a numeric
character.
-
L - indicates an alphabetic
character.
-
A - indicates an alphanumeric
character.
Note –
If the length of the input mask is greater than the value specified
for the max-length element, the length of the input mask is used.
|
|
value-mask
|
A mask used by the master index application to strip any extra characters
that were added by the input mask. This mask ensures that data is stored in
the database in the correct format. This mask must be the same length as the
input mask.
To specify a value mask, type the same value as is entered for the input
mask, but type an “x” in place of each punctuation mark. For example,
if an SSN field has an input mask of DDD-DD-DDDD, you need to specify a value
mask of DDDxDDxDDDD to strip the dashes before storing the SSN. A value mask
is not required for date fields.
|
|
value-list
|
The name of the
menu list used to populate the drop-down list for the field. This is required
if the gui-type specified for the field is MenuList, and
it must match a code of an element in the sbyn_common_header database table.
|
|
is-sensitive
|
An indicator of whether the value of the field is hidden on the MIDM for
records with a VIP status of “VIP”. Only users with the required
security permissions can view the hidden information. Specify true to
hide the field value; specify false (or remove the is-sensitive element) to display the field value.
Note –
This element is only used if the object-sensitive-plug-in-class in the impl-details section is populated.
|
|
key-type
|
An indicator of whether the field (or a combination of key fields) must
be unique in an enterprise record. Unique key fields identify unique child
objects in an enterprise object. For example, if the object structure contains
a child object for addresses and each record can have only one of each type
of address (for example, one home address and one work address), then the
address type field would be a key field. Specify true to
indicate the field is a key field; specify false if
it is not.
|
