Standard Fields
These fields are used primarily by the Record and Field records.
18. Position
- Description: This field identifies the position this entry is in the file in relation to its parent.
- Data Type: Count
- Allowed Values: Any
- Sample:
Position=5 - Found In: Record, Field, List, Value, Condition, Rule
19. ParentID
- Description: This field identifies the ID of the parent of this entry.
- Data Type: Count
- Allowed Values: Any
- Sample:
ParentID=2 - Found In: Record, Field, Value
20. Required
- Description: This field identifies if this entry must be present.
- Data Type: String List
- Allowed Values: YES, NO
- Sample:
Required=YES - Found In: Record, Field
A. YES
The record or field must be represented in the Data File record or Data File field, even if empty.
B. NO
The record or field may be represented in the Data File record or Data File field if it is empty, or it might not.
21. HasData
- Description: This field identifies if this record or field can be empty.
- Data Type: String List
- Allowed Values: ALWAYS, NEVER, OPTIONAL, CONDITIONAL
- Sample:
HasData=CONDITIONAL - Found In: Record, Field
A. ALWAYS
The Data File record or Data File field always has data.
B. NEVER
The Data File record or Data File field never has data.
C. OPTIONAL
The Data File record or Data File field can have data or not.
D. CONDITIONAL
Whether or not the Data File record or Data File field has to have data depends on all the Conditions and Rules involving it.
22. MinimumAllowed
- Description: This field defines the minimum number of times this entity can appear.
- Data Type: Count
- Allowed Values: Any
- Sample:
MinimumAllowed=1 - Found In: Record
23. MaximumAllowed
- Description: This field defines the maximum number of times this entity can appear.
- Data Type: Count
- Allowed Values: Any
- Sample:
MaximumAllowed=1 - Found In: Record
24. KeyField
- Description: This field identifies the ID of the field or fields that are used to link a record to its parent record.
- Data Type: Count
- Allowed Values: Any
- Sample:
KeyField=2 - Found In: Record
25. ParentKeyField
- Description: This field identifies the ID of the field or fields that are used in the parent record to link to this record.
- Data Type: Count
- Allowed Values: Any
- Sample:
ParentKeyField=1 - Found In: Record
26. RecordIDPositon
- Description: This field identifies the ID of the field to be inspected to identify the record.
- Data Type: Count
- Allowed Values: Any
- Sample:
RecordIDPosition=1 - Found In: Record
27. RecordIDValue
- Description: This field defines the value that identifies a record when the file uses that method to identify this record. Optionally it defines either an empty or not empty value.
- Data Type: String or String List
- Allowed Values: String: Any, String List: EMPTY, NOT EMPTY
- Sample:
RecordIDValue=HDR - Found In: Record
A. EMPTY
With the RecordIDPosition field, this field helps to identify which record the data line is for. This specifies that the identified field must not have data.
B. NOT EMPTY
With the RecordIDPosition field, this field helps to identify which record the data line is for. This specifies that the identified field must have data.
28. RecordRow
- Description: This field defines the row that identifies a record when the file uses that method to identify this record.
- Data Type: Count
- Allowed Values: Any
- Sample:
RecordRow=3 - Found In: Record
29. Width
- Description: This field defines the width of the entity when the File Type is fixed-width.
- Data Type: Count
- Allowed Values: Any
- Sample:
Width=243 - Found In: Record, Field
30. IsHeader
- Description: This field identifies a record as a header record. Only one record may be identified as a header.
- Data Type: String List
- Allowed Values: YES, NO
- Sample:
IsHeader=NO - Found In: Record
A. YES
The Data File record is the header record for the Data File.
B. NO
The Data File record is not the header record for the Data File.
31. TrailingDelimiter
- Description: This field defines if there is to be a field delimiter placed after the last field of a record.
- Data Type: String List
- Allowed Values: YES, NO, MULTIPLE
- Sample:
TrailingDelimiter=NO - Found In: Record
A. YES
The Data File record requires a final delimiter after the last field.
B. NO
The Data File record does not use a final delimiter after the last field.
C. MULTIPLE
Enough trailing delimiters are added to make this Data File record appear to have the same number of Data File fields as the Data File record with the most fields.
32. MinimumLength
- Description: This field allows the schema designer to specify the minimum number of characters that are allowed AFTER the data has been extracted from the field taking into account the enclosure and escape characters.
- Data Type: Count
- Allowed Values: Any
- Sample:
MinimumLength=5 - Found In: Field
33. MaximumLength
- Description: This field allows the schema designer to specify the maximum number of characters that are allowed AFTER the data has been extracted from the field taking into account the enclosure and escape characters.
- Data Type: Count
- Allowed Values: Any
- Sample:
MaximumLength=6 - Found In: Field
34. DataType
- Description: This field identifies the data type for this field.
- Data Type: String List
- Allowed Values: DATE TIME, NUMBER, STRING
- Sample:
DataType=NUMBER - Found In: Field
A. DATE TIME
The field data type is a date time string.
B. NUMBER
The field data type is a numeric value.
C. STRING
The field data type is a character string.
35. DateTimeFormat
- Description: This field identifies the date time format for this field when the data type is "DATE TIME".
- Data Type: String
- Allowed Values: Any valid Java DateTimeFormatter class string.
- Sample:
DateTimeFormat=yyyyMMdd - Found In: Field
36. ListID
- Description: This field identifies the ID of the List of allowed values for this field.
- Data Type: String
- Allowed Values: Any
- Sample:
ListID=36 - Found In: Field
37. StringRegex
- Description: This field allows the schema designer to specify the regular expression to validate the data in this field when the data type is "STRING".
- Data Type: String
- Allowed Values: Any valid Java Pattern class string.
- Sample:
StringRegex=^([1-9]|[1-9][0-9]|1[01][0-9])$ - Found In: Field
38. NumericMinimumValue
- Description: This field allows the schema designer to specify the minimum value of the field data when the data type is "NUMERIC".
- Data Type: Number
- Allowed Values: Any
- Sample:
NumericMinimumValue=0 - Found In: Field
39. NumericMaximumValue
- Description: This field allows the schema designer to specify the maximum value of the field data when the data type is "NUMERIC".
- Data Type: Number
- Allowed Values: Any
- Sample:
NumericMaximumValue=999.99 - Found In: Field
40. Start
- Description: This field allows the schema designer to specify the field start position when the File Type is Fixed-width. The first character in the record is position 1.
- Data Type: Number
- Allowed Values: Any
- Sample:
Start=10 - Found In: Field
41. Alignment
- Description: This field allows the schema designer to specify the alignment of the data in the field when the File Type is fixed-width.
- Data Type: String List
- Allowed Values: LEFT, RIGHT
- Sample:
Alignment=RIGHT - Found In: Field
A. LEFT
The alignment of the fixed-width data is to the left of the field.
B. RIGHT
The alignment of the fixed-width data is to the right of the field.
42. FillCharacter
- Description: This field allows the schema designer to specify the fill character of the data in the field in when the File Type equals "FIXED-WIDTH".
- Data Type: Integer
- Allowed Values: Any
- Sample:
FillCharacter=64 - Found In: Field