Format Builder

Reference Detail Window

A reference is used to indicate that another instance of the field or group format exists in the data. Reference fields or groups have the same format as the original field or group, but you can change the optional setting and the occurrence setting for the reference field or group. For example, if you have a "bill to" address and a "ship to" address in your data, you only need to define the address format once. You can create the "bill to" address definition and create a reference for the "ship to" address.

Note: References are given the same name as the original item. For example, the "bill to" address definition and the "ship to" address definition would be named the same.

Field	Description
Reference Description
Name	Displays the name of the original field or group for which you created this reference. This value cannot be changed.
Type	Indicates the type of data being used, for example, a string or integer
Optional	Select this option if the reference field or group is optional.
Field Occurrence
Occurrence	Choose one of the following to indicate how often this reference field or group appears in the message format: Once — Indicates the reference appears only once. Repeat Delimiter — Indicates the reference will repeat until the specified delimiter is encountered. For more information on delimiters, see Specify Delimiters. Repeat Field — Indicates the reference will repeat the number of times specified in the field denoted as the repeat field. Repeat Number — Indicates the reference will repeat the specified number of times. Unlimited — Indicates the reference will repeat an unlimited number of times.
Field Attributes
Field Update Buttons
Apply	Saves your changes to the message format document.
Edit Reference	Displays the detail window for the original item so you can edit the details of the referenced field or group.
Reset	Discards your changes to the detail window and resets all fields to the last saved values.
Help	Displays online help information for this detail window.

 

Note: The Apply and Reset buttons are only enabled once changes are made to the detail panel's components.