XML output documents
The XML output documents that are returned as output from common SQL API stored procedures share a common set of entries.
At a minimum, the XML output documents that are returned
in the xml_output parameter include the following
key and value pairs, followed by information that is specific to each
stored procedure:
<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
<key>Document Type Name</key>
<string>Data Server Configuration Output</string>
<key>Document Type Major Version</key><integer>1</integer>
<key>Document Type Minor Version</key><integer>0</integer>
<key>Data Server Product Name</key><string>DSN</string>
<key>Data Server Product Version</key><string>9.1.5</string>
<key>Data Server Major Version</key><integer>9</integer>
<key>Data Server Minor Version</key><integer>1</integer>
<key>Data Server Platform</key><string>z/OS</string>
<key>Document Locale</key><string>en_US</string>
<!-- Document type specific data appears here. -->
</dict>
</plist>
The Document Type Name key varies
depending on the stored procedure. This example shows an XML output
document for the GET_CONFIG stored procedure. In addition, the values
of the Document Type Major Version and Document
Type Minor Version keys depend on the values that you specified
in the major_version and minor_version parameters
for the stored procedure.Entries in the XML output document
are grouped by using nested dictionaries. Each entry in the XML output
document describes a single piece of information. In general, an XML
output document is comprised of Display Name, Value,
and Hint, as shown in the following example:
<key>SQL Domain</key>
<dict>
<key>Display Name</key>
<string>SQL Domain</string>
<key>Value</key>
<string>v33ec059.svl.ibm.com</string>
<key>Hint</key>
<string />
</dict>
XML output documents are generated in UTF-8 and contain only English characters.