Home > Calculation Setup > Output Definitions > XML Output Linkage > Plan Dependent

Plan Dependent

The Plan Dependent tab allows you to specify where to store the results of the calculation in the XML document.  Some results require special containers in which to store the information; see Reserved XML Elements for their structure.  In addition, you can create field names that are used in conjunction with an XML Output Definition.

The main Plan Dependent dialog lists all of plan dependent fields that are currently defined in this XML Output LInkage in a sortable listview field along with other key information about each field.  If the field definition is incomplete, the first column for the field holds an asterisk (*).  If the field definition references an XML tag with a PADescription attribute, the second column for the field holds an at sign (@). If the field is nillable in the XML Schema, the third column holds an "n".  There is also a Varies by column after the field names that indicates whether the results will vary by decrement, commencement, payment form; if this column is blank (such as for an input pass through), the results will be included at the top of the XML results before the "varies by" sections. The last column shows the unique internal id for each Plan Dependent field.

Please note that two XML Output Linkages may appear to be identical, but their internal ids for Plan Dependent and Input Pass Thru fields may differ, so if you have an Output Definition and switch the XML Output Linkage, the Output Definition fields may change without explanation (because the internal ids are different). Since the internal ids are shown on the XML Output Linkage view, it is advisable to compare XML Output Linkages before changing the reference in an Output Definition to make certain that only the desired changes are made.

Clicking on the name of an existing entry or clicking the New… button will provide the Plan Dependent dialog box:

Field description is a description of the field that will house the value provided by the calculation.

Varies by: presents fours choices to designate when the value is computed. Select either:

Container: will display the path to the decrement date, commencement date, or payment form level as specified in the Schema Structure tab. The selection <none > will have <unspecified> as the container.

Tag: clicking the button allows you to select the tag name for storage of the value of the field. Tag date type: then shows the type (such as numeric or date) followed by "with PADescription attribute" if appropriate, both per the designation in the XML Schema of the tag name selected.

When values are computed at the Payment form level, additional options are presented. Putting a check mark in any of the boxes will make the button available for selection of the Tag name for:

Deferred commencement date is applicable when payment(s) begin after the benefit commencement date.

Temporary stop date is applicable when payments are temporary.

Beneficiary amount is applicable when the payments are a joint & survivor type.

Pop-up amount is applicable when the payments are a joint & survivor with pop-up type

Refund annuity guaranteed amount is applicable when the payments are a refund annuity type.

Post Social Security Level Income is applicable when payments are Social Security Level Income type. Clicking the image\ebx_-559568474.gif button displays the Post Social Security Level Income Tags dialog box where the following tags are defined:

Amount tag is the tag name for the member’s amount after the leveling date.

Commencement date tag is the tag name for the leveling date..

Beneficiary amount tag is the tag name for the beneficiary amount..

Lump sum equivalent and relative value is applicable when relative values and/or lump sum equivalents are needed for the output. Clicking the image\ebx_-559568474.gif button displays the Lump Sum Equivalent and Relative Value tags dialog box where the following tags are defined:

Lump Sum Equivalent tag is the tag name for the lump sum equivalent amount.  This will be the amount associated with the Actuarial equivalence interest & mortality choice, i.e., the primary relative value basis, of the Relative Value Calculations topic of Plan Definitions

Relative Value Tag is the tag name for the relative value fraction.

The Include lump sum equivalent when relative value applicable checkbox will provide both lump sum equivalent and relative values amounts.