API Inputs

You can enable documents for assembly as tagged PDFs through the parameters submitted on a request message to the Expere Engine. To do this, in the request message you must pass an enumerated option, TaggedPDF, on the DocumentFormat object. This option can be submitted as part of the request message in the following operations: SelectAndGenerate, Generate, AssembleDocuments, and AssembleDocumentsSet.

The following example shows a representative request message that is submitted to enable assembly of TaggedPDF documents. In this example, a request is submitted on the SelectAndGenerateRequest object and the Tagged PDF values are in bold for emphasis.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <soapenv:Body>
 <SelectAndGenerateRequest xmlns="">
 <Transaction xmlns="">[Data]</Transaction>
 <Organization xmlns="">[Data]</Organization>
 <PackageID xmlns="">PKG.MortgageClosing</PackageID>
 <DocumentFormat>TaggedPDF</DocumentFormat>
 <DynamicPdfRender>FOP</DynamicPdfRender>
 </SelectAndGenerateRequest>
 </soapenv:Body>
</soapenv:Envelope>

The following example shows the TaggedPDF value on the DocumentFormat (DocumentFormatType) object in the WSDL. These values correspond to those submitted on a request message shown in the preceding section.

<xs:element minOccurs="0" maxOccurs="1" name="DocumentFormat" type="tns:DocumentFormatType"/>

In the Expere API, the DocumentFormatType (including the enumeration to enable Tagged PDFs) is submitted on a SOAP request message:


<xs:complexType name="DocumentFormatType">
 <xs:sequence>
 <xs:element minOccurs="0" name="Enum" type="tns:DocumentFormatTypeEnum"/>
 </xs:sequence>
 </xs:complexType>
 <xs:element name="DocumentFormatType" nillable="true" type="tns:DocumentFormatType"/>
 <xs:simpleType name="DocumentFormatTypeEnum">
 <xs:restriction base="xs:string">
 <xs:enumeration value="PDF"/>
 <xs:enumeration value="RAW_XML"/>
 <xs:enumeration value="RTF"/>
 <xs:enumeration value="TaggedPDF"/>
 </xs:restriction>
 </xs:simpleType>
 <xs:element name="DocumentFormatTypeEnum" nillable="true" type="tns:DocumentFormatTypeEnum"/>

Accessible PDF outputs require the use of Apache FOP for print formatting. In the Expere API, the DynamicPdfRender (including the enumeration to enable FOP) object is submitted on a SOAP request message:

 
<xs:complexType name="DynamicPdfRender">
 <xs:simpleContent>
 <xs:extension base="tns:DynamicPdfRenderEnum"/>
 </xs:simpleContent>
 </xs:complexType>
 <xs:simpleType name="DynamicPdfRenderEnum">
 <xs:restriction base="xs:string">
 <xs:enumeration value="FOP"/>
 </xs:restriction>
 </xs:simpleType>

Note: Apache FOP is a PDF rendering method used by the Expere Engine and must be used to generate accessible PDF output.