Home > Calculation Setup > Output Definitions > XML Output Linkage > Schema Structure

Schema Structure

ProAdmin organizes portions of a calculation by different levels. The XML output document is assumed to have a structure where a decrement level container may have one or more commencement level containers and a commencement level container may have one or more payment form containers. The Schema Structure tab is where each level is determined.

It is possible to type in the path/tag for each required item, but it is generally more efficient to click the  button to the right of each item to choose from the list of tags in the XML schema document by clicking on its name.

The Name field on the tab can be a phrase of any length. All characters are permissible including spaces. Include key information about the use of the XML Output Linkage.

The Decrement Level box holds the XML container that will store results for intermediary computations and any Reserved XML Elements that are made at termination date. Click on the image/ebx_-809421490_8.gif button to select the appropriate tag.  This decrement level choice will control what tags are displayed by the look-up buttons when you set up fields that vary by decrement on the other XML Output Linkage tabs.

If you want to keep each of the benefits in its own container, check the box Benefit level (within Decrement) checkbox to make the Benefit Level box available. Click on the  button to select the appropriate tag to contain the detail for each benefit.

The Commencement Level (within Benefit or Decrement) box holds the XML container that will store results for intermediary computations that are made at commencement date. The button will only display the XML Schema tags and containers within the Decrement Level selected above (unless Benefit level (within decrement) is checked, in which case only the tags and containers within that container will be displayed).  This commencement level choice will control what tags are displayed by the look-up buttons when you set up fields that vary by commencement on the other XML Output Linkage tabs.

The Payment Form Level (within Commencement) box holds the XML container that will store payment form information. The button will only display the tags and containers within the commencement level selected above. This payment form choice will control what tags are displayed by the look-up buttons when you set up fields that vary by payment form.

The topics within the Select an output topic: choice list further define the output to be provided in the output XML:

Key Fields 
Audit Report 
User Defined Errors/Warnings  
Application Defined Errors/Warnings 
System Errors  

An asterisk before any item in the list ("Incomplete topic definition") means that no output of this type will be included in the XML output.

Check the Write nillable nodes to the XML output box if your XML Schema includes nillable elements and you want to have them reflected in the XML output.

Check the Use a stored procedure to write XML results to write back your XML Output Definition results to the SQL Server (see Use a stored procedure to write XML results for more details). When checked, the Params button unghosts, and you can click it to name the stored procedure (provided by your DBA) and specify its arguments. After you run a calculation and view the XML or XML+XSL results (under the Options button in the Calculation Results view), then you can write the XML results (or if appropriate, the XML+XSL results) to SQL Server.

The name of the current XML Schema is displayed at the bottom of the dialog box.  It can be changed, exported or viewed by clicking on the XML Schema... button on the bottom of the dialog.