The XSDBind file is used to install an XML transformation resource (XMLTRANSFORM) under CICS® Transaction Server version 4.1 and later. The XMLTRANSFORM resource is used by the CICS EXEC APIs, TRANSFORM XMLTODATA and TRANSFORM DATATOXML.
The XMLTRANSFORM resource can be used to perform the XML transformation in both directions (DATATOXML and XMLTODATA), for one XML document and for one data structure. This is in contrast to the WEBSERVICE resource in which transformation to an XML document can be different from the transformation to a data structure.
There are two kinds of XSDBind files that may be generated: Native XSDBind and Vendor XSDBind.
The following shows which generation properties are associated with each XSDBind file type and examples of how to specify them.
<PlatformArray>
<Platform>
<CodegenPropertyArray>
<CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_CONVERSION_TYPE"
value="interpretive"/>
</CodegenPropertyArray>
</Platform>
</PlatformArray>
<EISProject
xmlns="http:///com/ibm/etools/xmlent/batch/emf/BatchProcessModel.ecore"
name="CICSPROGProject">
<EISService name="CICSPROG">
<Operation>
<MessageSpec importFile="CICSPRG.cbl" importDirectory="."
nativeTypeName="DFHCOMMAREA"/>
<XseSpec>
<XSDBindSpec fileName="CICSPROG.xsdbind" logFileName="CICSPRG.log"/>
</XseSpec>
</Operation>
</EISService>
</EISProject>
<PlatformArray>
<Platform>
<CodegenPropertyArray>
<CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_CONVERSION_TYPE"
value="compiled"/>
</CodegenPropertyArray>
</Platform>
</PlatformArray>
<EISProject
xmlns="http:///com/ibm/etools/xmlent/batch/emf/BatchProcessModel.ecore"
name="CICSPROGProject">
<EISService name="CICSPROG">
<Operation>
<MessageSpec importFile="CICSPRG.cbl" importDirectory="."
nativeTypeName="FHCOMMAREA"/>
<XseSpec>
<DriverSpec fileName="CICSPRGD.cbl" driverType="XML_TRANSFORM_CICS"
programName="CICSPRG"/>
<ConverterSpecIn fileName="CICSPRGD.cbl" programName="BUP001"/>
<ConverterSpecOut fileName="CICSPRGD.cbl" programName="BUP001"/>
<XSDBindSpec fileName="CICSPROG.xsdbind" logFileName="CICSPROG.log"
mappingLevel="VENDOR" minimumRuntimeLevel="VENDOR"/>
</XseSpec>
</Operation>
</EISService>
</EISProject>
Table 1 shows the attributes for XSDBindSpec.
| Fields | Description |
|---|---|
Attribute: bundle |
Specifies the path and name of the bundle directory. If you specify this value, the XML schema (which you must specify in the XSDSpec element) and the XML binding file is generated in the bundle directory and a bundle manifest is also created. The path information on this parameter overrides any path information on the XSDSpec fileName attribute and XSDBindSpec fileName attribute. |
Attribute: ccsid |
Specifies the CCSID that is used at run time to encode data between the application program and the XML binding file. The value of this parameter overrides the value of the LOCALCCSID system initialization parameter. The value must be an EBCDIC CCSID that is supported by Java and z/OS® conversion services. If you do not specify this parameter, the application program uses the CCSID specified in the system initialization parameter, and the XML binding file is encoded in US EBCDIC (Cp037). |
Attribute: charVarying (EISService) |
Specifies how character arrays in the language
structure should be mapped when the mapping level is 1.2 and higher. Note: This
parameter does not apply to Enterprise and Other PL/I language structures.
The
options you can select are:
Required elements:
|
Attribute: charVarying |
Specifies how variable length character data
is mapped when the mapping level is 1.2. Variable length binary data
types are always mapped to either a container or a varying structure.
If you do not specify this parameter, the default mapping depends
on the language specified. The options that you can select are:
Required Batch Options:
|
Attribute: charVaryingLimit |
Specifies the maximum size of binary data and
variable length character data that is mapped to the language structure
when the mapping level is 1.2. If the character or binary data is
larger than the value specified in this parameter, it is mapped to
a container and the container name is used in the generated language
structure. The value can range from 0 to the default 32767 bytes. Required
Batch Options:
|
Attribute: defaultCharMaxLength |
Specifies the default array length of character
data in characters for mappings where no length is implied in the
Web service description document, when the mapping level is 1.2. The
value of this parameter can be a positive integer in the range of
1 to 2147483647. Required Batch Options:
|
Attribute: fileName |
Specifies the name of the output file The default value is: Data source file name concatenated with ".xsdbind" |
Attribute: inlineMaxOccursLimit |
This attribute is equivalent to the INLINE-MAXOCCURS-LIMIT parameter of the CICS XML Assistant DFHLS2SC. The value is used to decide whether or not to in-line variable repeating content based on the value of the maxOccurs attribute from the source WSDL. The full description can be found in the CICS Transaction Server V 4.1 InfoCenter, see: |
Attribute: logFileName |
Specifies the name of the log file generated
by the XML Assistant. This attribute value is used only when the following
is specified in the PlatformProperties.xml file: <CodegenPropertyname="com.ibm.etools.xmlent.ui.
GEN_CONVERSION_TYPE "value="interpretive"/> The default value is: fileName concatenated with ".log" |
Attribute: mappingLevel |
Specifies the version of the programmatic interface
shared between CICS and the application. Generally, it is best
to specify the highest mapping level that is available:
The use of old mapping levels is only recommended when regenerating
the XML binding files for XML transformation resources that were previously
deployed with an old mapping level. The details on the mapping levels
can be found in the online CICS Transaction Server Infocenter, see:
|
Attribute: mappingLevel (continued) |
|
Attribute: minimumRuntimeLevel |
Specifies the minimum CICS runtime
environment that the XML binding file can be deployed into. An error
message is displayed if a level is selected that does not match the
other parameters specified.
|
Attribute: vendorConverterName |
Specifies the program name of the main program
entry. The default value is: DriverSpec/@fileName |
Attribute: dateTime |
Specifies how the XML elements of xsd:dateTime type are mapped into CICS ASKTIME format. This attribute is only valid for the CICS interpretive conversion type. If it is specified for the Vendor (Compiled) conversion type, it is ignored. This attribute is only valid at Mapping level 3.0 and higher. If this attribute is specified in a top-down scenario
(that is the XSDBindSpec is specified inside the EISServiceImplementation)
then the valid values are:
If this attribute is specified in a bottom-up
(that is, the XSDBindSpec is specified inside the EISService) then
the valid values are:
|
Attribute: dataTruncation |
Specifies how truncated data is treated by the CICS native
conversion mechanism:
Note: The ENABLED setting is only supported at mapping levels
3.0 and higher.
|
Related reference
CICS Web services assistant:
http://publib.boulder.ibm.com/infocenter/cicsts/v3r2/topic/com.ibm.cics.ts.webservices.doc/concepts/dfhws_utility.html
<XSDBindSpec fileName="CICSPROG.xsdbind"
mappingLevel="VENDOR" logFileName="CICSPROG.log" ccsid="37"
minimumRuntimeLevel="VENDOR">
</XSDBindSpec>