Home > Data > XML Output Linkage > Schema Structure > Key Fields

Key Fields

The Key Fields topic defines the tag names for the major sections of the XML output document, indicating where to report output items that vary by decrement, benefit, commencement and/or payment form.  A path for Decrement Date and Commencement Date are required. All other paths are optional; checking the box in front of the item indicates that the detail should be included in the XML output at the specified path.
Clicking on the button after any output path parameter will bring up the XML Schema Document dialog that displays the relevant XML Parent Path and provides a list of all of the tags defined within that path in the XML Schema .xsd document associated with this XML Output Linkage.  Clicking on a path in the Select an XML path: choice list will cause a checkbox to appear before it in the list, and then clicking OK will populate the Key Fields dialog with the chosen path.

There are four potential levels of detail in the XML output for which key fields may be specified:  decrement, benefit, commencement and payment form. 

The only key field available at the Decrement Level Detail is the Decrement Date. Select a tag from within the decrement level container (which is specified on the main Schema Structure tab) to contain the decrement date. This is a required field.

There are several optional key fields available for Benefit Level Detail. The items are available if Benefit Level (within decrement) is selected on the main Schema Structure tab. The output for each Benefit Definition can include:

Code: If checked, select the appropriate tag that will contain the XML code specified in the Benefit Definition.  This field is optional.

Description: If checked, select the appropriate tag that will contain the Name specified for the Benefit Definition.  This field is optional. 

Normal form code: If checked, select the appropriate tag that will contain the XML Output Type Code specified for the normal form of payment of the Benefit Definition. This field is optional.

The Commencement Level Detail section requires specification of a tag for the Commencement Date.  In addition, if Error indicator is checked, select the appropriate tag name that will have a value of 1 if there are no valid payment forms for the commencement date, or 0 if there is at least one valid payment form for the commencement date.

There are several optional key fields available for Payment Form Detail:

Code: If checked, select the appropriate tag that will contain the XML Output Type Code specified for the payment forms.  This field is optional.

Percent: If checked, select the appropriate tag that will contain the percentage payable to the beneficiary when the annuity is a joint life annuity. This field is optional.

Units: If checked, select the appropriate tag that will contain the period certain (in years) of the payment form.  The tag will have a value of 0 for all payment forms without a certain period. This field is optional.

Name: If checked, select the appropriate tag that will contain the name of the payment form (as specified in the associated Payment Form library entry). This field is optional.

Normal indicator: If checked, select the appropriate tag that will contain an indicator of 1 (one) if the payment form is the normal form, or 0 (zero) if it is not the normal form. This field is optional.

Conversion factor: If checked, select the appropriate tag that will contain the conversion factor for each payment form. This field is optional. Note that some payment forms have more than one conversion factor, but only one conversion factor will be written to XML.  Also, some payment forms have no conversion factor output.