Base Field Set elements

Use the Base Field Set page to manage base field sets. Table 2-4 describes fields on this page.

Table 2-4 Base Field Set Elements

Element	Description	Data Input Notes
Base Field Set Name	Name of this Base Field Set Definition	Format: String - alphanumeric and underscore; must contain at least one letter or number, and cannot start with a number Range: 1-64 characters Default: Blank
Element String	XML element name under which defined fields reside.	Format: String - alphanumeric and underscore; must contain at least one letter or number, and cannot start with a number Range: 1-64 characters Default: Blank
Allow Versions	Indicates whether multiple versions of this entity are allowed.	Format: Checkbox Range: Checked, unchecked Default: Unchecked
Version Identifier Element	The XML element name of the version identifier. This element is enabled only if the Allow Versions element is checked.	Format: String - alphanumeric and underscore; must contain at least one letter or number, and cannot start with a number Range: 1-64 characters Default: Blank
Version Value	The version value of the XML blob associated with the base field set. This element is enabled only if the Allow Versions element is checked.	Format: Numeric Range: 0-4294967295 Default: Blank
XML Storage Format	Indicates whether the entity version is element based or field name based.	Format: Dropdown list Range: Element Based, Field Name Based Default: Element Based

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

Table 2-5 Base Field Elements

Element	Description	Data Input Notes
Element String	XML element name under which defined fields reside. If Field Set is selected from the Type dropdown list, then this Element String value is automatically populated with the Element String value of the field set selected from the Field Set Name dropdown list.	Format: String - alphanumeric only; must contain at least one letter or number. String value can start with a number if XML Storage Format is Field Name Based, value cannot start with a number if XML Storage Format is Element Based. 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 be referenced only 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 transparent 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 field value can be sent in an update request.	Format: Checkbox Range: Checked, unchecked Default: Unchecked
Resettable	Sets the field 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 if a reset operation is performed. This element is enabled only if the Resettable element is checked. Note that this value is validated using the regex expression specified in the Special Format element.	Format: Numeric Range: 0-4294967295 Default: Blank
Defaultable	Sets the field 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 if a value is not specified in the insert request. This element is enabled only if the Defaultable element is checked. Note that 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 set to 0, then the field does not have to exist. If set to 1 or more, then the field is mandatory, and the specified number of instances must exist for the Entity to be valid.	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 occurrences.	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