Record element in FSD

The record element defines the structure of a record. A record consists of a sequence of fields and (optionally) a record separator. 

<record
		name
		output='yes|no'
		record-sep
		max-occur
		min-occur
				<field/>
</record>

Attributes

  • name

    Defines the name of the choice. If the output attribute is set to yes this name is used as the XML tag name in the output, and used to match the choice with an XML tag during input.

  • output

    Defines whether the record is to be included in the output or not. The valid values for this attribute are yes and no, where a value of yes means the record causes a tag to be generated in the output and no means that the sequence is purely describing the data structure and does not appear in the output.

    The default for this attribute is yes.

  • record-sep

    Define an optional record separator string for the record. This can be any string value. The following special values are also acceptable:

    • \r The carriage-return character
    • \n The line-feed character
    • \t The tab character
  • max-occur

    Defines the maximum number of occurrences for the record. A value of zero means there can be any number of occurrences. The default for this attribute is 1.

  • min-occur

    Defines the minimum number of occurrences for the record. The default for this attribute is 0.

Remarks

A record consists of fields, and these fields must be in the correct order. Unlike sequence and choice, a record can only contain fields.

Note: The names used for fields in flat schemas must be valid XML Element names. The XML specification explicitly excludes half-width Katakana characters (also known as single-byte Katakana), so do not use these characters when naming a field. Every half-width character has a normal width equivalent in the Unicode character set, so these must be used instead.