Home > Data > XML Output Linkage > Schema Structure > PADescription Attributes

PADescription Attributes

PADescription Attributes

A PADescription a special attribute that you can define in the schema of your XML Output Linkage. When XML output is created, if ProAdmin finds a PADescription attribute, it will write the description of the corresponding Benefit Detail , Date/Age/Service , Input Pass Thru , or Standard output result item (defined in the Output Definition) to the PADescription attribute in the output XML.

To use the PADescription attribute, you need to add the following to the top your XML Output Linkage schema. Copy what’s in blue and paste into the top of your schema, after the xs:schema and before your root element (e.g., <xs:element name="PROADMIN_CALC_RSLT">. You may need to change xs: to xsd: depending on the namespace defined in your schema (e.g.,  xmlns:xs="http://www.w3.org/2001/XMLSchema" or xmlns:xsd="http://www.w3.org/2001/XMLSchema").

<xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">

   <xs:complexType name="PADecimal">
<xs:simpleContent>
<xs:extension base="xs:decimal">
<xs:attribute name="PADescription" type="xs:string"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="PAString">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="PADescription" type="xs:string"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="PADate">
<xs:simpleContent>
<xs:extension base="xs:date">
<xs:attribute name="PADescription" type="xs:string"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>

<xs:element name="PROADMIN_CALC_RSLT">
<xs:complexType>
<xs:sequence>
...

For elements in your XML output that need the PADescription attribute, change the data type to PADecimal, PAString, or PADate. For example:

     <xs:element name="DOB" type="PADate" minOccurs="0"/>    
...
     <xs:element name="VSTSVC1" type="PADecimal" minOccurs="0"/>
     <xs:element name="VSTSVC2" type="PADecimal" minOccurs="0"/>
     <xs:element name="VSTSVC3" type="PADecimal" minOccurs="0"/>
...
     <xs:element name="SUBFUND" type="PAString"/>


Now the Benefit Detail, Date/Age/Service, Input Pass Thru, or Standard Result descriptions will be written out in the XML as the PADescription attribute:

<PROADMIN_CALC_RSLT>
<Person>
<DOB PADescription=”Participant date of birth”>1956-02-03</DOB>
...
<VSTSVC1 PADescription=” Vesting Service at 1st event”>1.25</VSTSVC1>
<VSTSVC2 PADescription=” Vesting Service at 2nd event”>5.75</VSTSVC2>
<VSTSVC3 PADescription=” Vesting Service at 3rd event”>11.5</VSTSVC3>
...
<SUBFUND PADescription=”Secondary Location”>Endicott</SUBFUND>
...



When an item is missing, then neither the value nor the attribute are written to XML.

These custom XML Output Linkage data types cannot be used to output a PADescription for arrays, containers, Key Fields, User-Defined Errors/Warnings, Application-Defined Errors/Warnings, or System Errors.  You also cannot output a description for Standard output results to the payment form level.