FSD Record tag

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 then 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 if the record is to be included in the output. The valid values for this attribute are:

    • yes

      the record generates the tag in the output

    • no

      the sequence describes only the data structure and does not appear in the output.

      The default value is yes.

  • record-sep

    Defines an optional record separator string for the record. This can be any string value. These 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 is one.

  • min-occur

    Defines the minimum number of occurrences for the record.

    The default for this attribute is zero.

Remarks

A record consists of fields, and these fields must be in the correct order. Unlike sequences, 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. These characters must not be used when naming a field. Every half-width character has a normal width equivalent in the Unicode character set, so these must be used instead.