Field Set elements

Use the Field Set page to manage transparent entity field sets. Table 2-2 describes the elements that can be configured for a field set.

Table 2-2 Field Set Elements

Element	Description	Data Input Notes
Field Set Name	Name of the transparent entity field set.	Format: String - valid characters are alphanumeric and underscore; must contain at least one alphabetic or numeric character, and cannot start with a number Range: 1-64 characters Default: Blank
Element String	XML element name under which defined fields reside.	Format: String - valid characters are alphanumeric and underscore; must contain at least one alphabetic or numeric character, and cannot start with a number Range: 1-64 characters Default: Blank
Repeatable	Indicates that the field set is a repeatable element. When multiple instances of data exist in an entity, a repeatable element contains the data fields for a specific instance of an entity. When this element is checked, the Instance Identifier Attribute element is enabled.	Format: Checkbox Range: Checked, unchecked Default: Unchecked
Instance Identifier Attribute	XML attribute instance associated with a repeatable element. This value indicates which repeatable element is being selected. This element is enabled only if the Repeatable element is checked.	Format: String - valid characters are alphanumeric and underscore; if enabled, must contain at least one alphabetic or numeric character, and cannot start with a number Range: 0-64 characters Default: Blank

In the lower part of the Field Set page, use the Add Field button to add a data field record to this field set. Table 2-3 describes the elements that can be configured for each data field record.

Table 2-3 Field Elements

Element	Description	Data Input Notes
Element String	The name of the XML element defined in the field set. If Field Set is selected from the Type dropdown list, then the Element String value for the field is automatically populated with the Element String value of the field set selected from the Field Set Name dropdown list.	Format: String; if the parent Base Field Set is Element Based, the format of Element String is alphanumeric and underscore, must contain at least one alphabetic or numeric character, and cannot start with a number Range: 1-64 characters Default: Blank
Type	Field type. If Field Set is selected, then the Min/Max Value, Updatable, Resettable, Reset Value, Defaultable, Default Value, and Special Format elements are disabled. If RegEx is selected and Resettable or Defaultable is check marked, the value in the associated element (Reset Value or Default Value) is validated using the regex expression in the Special Format element.	Format: Dropdown list Range: Integer, Regex, Field Set Default: Regex
Field Set Name	Previously defined transparent entity field set where the field will be assigned. Note that a specific Field Set Name can only be referenced once by another field set or base field set. This element is enabled only if Field Set was selected from the Type dropdown list.	Format: Dropdown list Range: Previously defined tranparent entity field set Default: Blank
Min Value	The minimum field value allowed.	Format: Numeric Range: 0-4294967295 Default: Blank
Max Value	The maximum field value allowed.	Format: Numeric Range: 0-4294967295 Default: Blank
Updatable	Indicates that the value can be sent in an update request.	Format: Check box Range: Checked, unchecked Default: Unchecked
Resettable	Sets the value to the value in the Reset Value element if a reset operation is performed.	Format: Checkbox Range: Checked, unchecked Default: Unchecked
Reset Value	Value to set the field to if a reset operation is performed. This element is enabled only if the Resettable element is checked. Note that if a Type of RegEx is specified, this value is validated using the regex expression specified in the Special Format element.	Format: Numeric Range: 0-4294967295 Default: Blank
Defaultable	Sets the value to the value in the Default Value element if a value if not specified in the insert request.	Format: Checkbox Range: Checked, unchecked Default: Unchecked
Default Value	Value to set the field to if a value is not specified in the insert request. This element is enabled only if the Defaultable element is checked. Note that if a Type of RegEx is specified, this value is validated using the regex expression specified in the Special Format element.	Format: Numeric Range: 0-4294967295 Default: Blank
Min Occur	Indicates if the field is mandatory or optional. If the value is 0, then the field does not have to exist. If the value is 1 or more, then the field is mandatory, and the specified number of instances must exist for the Entity to be valid. Note that when Defaultable is check marked, this value must be either 0 or 1.	Format: Numeric Range: 0-4294967295 Default: Blank
Max Occur	Indicates the maximum number of occurrences of the field. A value of NO_LIMIT indicates an unlimited number of occurrances.	Format: Numeric Range: 0-4294967295 Default: Blank
Special Format	This element is a regular expression, conforming to the Perl regular expression syntax. This value must match the entire regular expression to be considered valid. This value can be used to apply advanced/special field validation if required (i.e., validation of the value in the Default Value or Reset Value element).	Format: String Range: 1-64 characters Default: Blank