XML output documents
The XML documents that are returned as output from common SQL API stored procedures share a common set of entries.
At a minimum, XML documents returned in the xml_output parameter include the following mandatory, key value pairs:
<?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>8.1.0.356</string>
<key>Data Server Major Version</key><integer>8</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>
Entries in the XML output document might be grouped
using nested dictionaries. Each entry in the XML output document describes
a single piece of information. The entry consists of the value, the
display name, and a hint. Optionally, a display unit might be provided.
Display name, hint, and display unit are language-sensitive and will
be translated to the language specified in the value for the requested_locale parameter (or the default if the requested
locale is not yet supported). In general, an entry has a structure
similar to the following example:
<key>Real Storage Size</key>
<dict>
<key>Display Name</key><string>Real Storage Size</string>
<key>Value</key><integer>2048</integer>
<key>Display Unit</key><string>MB</string>
<key>Hint</key><string>Size of actual real storage online</string>
</dict>
IBM data servers have a common parameter document
that includes some keywords that are applicable to all data servers,
and others that are data server specific. Whenever a data server adds
or removes a new keyword, the version number (for all data servers)
is incremented. Depending on the change, the major version number
might be increased and the minor version number set to 0 (zero), or
only the minor version number might be incremented.XML output documents are generated in UTF-8 and contain English characters only.