Home > Data > XML Database Linkage > Key Fields

Key Fields

When running calculations using ProAdmin Server or ProAdmin Online, the same information is needed as is entered in the ProAdmin Desktop dialog boxes when running a Calculation (Estimated, Final, Dates/Age/Service or Batch). The information entered in the ProAdmin Desktop dialog boxes are key fields for the calculation. Since all calculations are done on an individual basis, the XML schema document requires a path to these key fields.

The Description field can be a phrase of any length. All characters are permissible.

Select a topic: presents the following topics relative to key fields. Clicking on a topic displays a dialog box regarding that topic.

Decrement date: enter the XML container path, or click the  button to select the XML container path or tag name/path, that contains the decrement date(s).  The XML Schema Document dialog that presents when you click the   button allows you to sort the available XML container paths or tag name/path by data Type or XML Path/Tag for easier selection. Click on the desired entry and it will be populated as the patch in the calling dialog.

Commencement date: enter the XML container path, or click the button to select the XML container path or tag name/path, that contains the benefit commencement date(s). The XML Schema Document dialog that presents when you click the   button allows you to sort the available XML container paths or tag name/path by data Type or XML Path/Tag for easier selection. Click on the desired entry and it will be populated as the patch in the calling dialog.

Calculation Type: enter the XML container path, or click the button to select the XML container path or tag name/path, that contains the calculation type. The XML Schema Document dialog that presents when you click the   button allows you to sort the available XML container paths or tag name/path by data Type or XML Path/Tag for easier selection. Click on the desired entry and it will be populated as the patch in the calling dialog.

When reading XML documents that use ProAdmin Server or ProAdmin Online, it is necessary for ProAdmin to know which of the three calculation types, Final, Estimate or Dates, the document contains. Enter the calculation type value which indicates: allows you to enter the values that will be used for the calculation type. This information is not needed when running individual calculations that use an XML linkage through ProAdmin desktop.

Decrement Type: enter the XML container path, or click the button to select the XML container path or tag name/path, that contains the decrement type. The XML Schema Document dialog that presents when you click the   button allows you to sort the available XML container paths or tag name/path by data Type or XML Path/Tag for easier selection. Click on the desired entry and it will be populated as the patch in the calling dialog.

When reading XML documents that use ProAdmin Server or ProAdmin Online, it is necessary for ProAdmin to know which of the three decrement types, Retirement/Termination, Disability or Death, the document contains. Enter the decrement type value which indicates: allows you to enter the values that will be used for the decrement type. This information is not needed when running individual calculations that use an XML linkage through ProAdmin desktop.  

Estimate Overrides: Check the boxes for any assumption overrides you may want to supply in the XML.  You may choose to Override the salary inflation assumption and/or Override the cash balance interest crediting assumption. For each box checked, enter the XML container path, or click the button to select the XML container path or tag name/path, that contains the values for the override.  The XML Schema Document dialog that presents when you click the   button allows you to sort the available XML container paths or tag name/path by data Type or XML Path/Tag for easier selection. Click on the desired entry and it will be populated as the patch in the calling dialog.

Global filter: enter a global filter that will be prepended as an and condition to the filters of all linked data fields in the XML Database Linkage. For example, suppose you only want the data associated with a particular plan (e.g., PlanID 321). Then you could define the global filter as PlanID = 321​. If not every data element is associated with a PlanID, for example, date of birth, then you could use a filter like not(boolean(PlanID)) or (PlanID = 321). If the PlanID node doesn't exist for date of birth, then boolean(PlanID)returns false, and not(boolean(PlanID) is true, so date of birth (or any node not associated with a PlanID), the global filter not(boolean(PlanID)) or (PlanID = 321) is true, and the data will be loaded (as long as the individual field's XML Data Link filter is empty or evaluates to true).

Note: be aware that an XML document is by nature a text document and this makes the Filter case sensitive. If the data inside of the XML tags is lower case and you enter a Filter condition in upper case the condition will not be met.

An asterisk (*) denotes which topic definitions are incomplete.