The WSBind file is used to install a new Web service under CICS® Transaction Server version 3.1 and later.
There are two kinds of WSBind files that may be generated: Native WSBind and Vendor WSBind.
The following shows which generation properties are associated with each WSBind 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>
<OutputMessage importFile="CICSPROG.cbl" importDirectory="."
nativeTypeName="DFHCOMMAREA"/>
<InputMessage importFile="CICSPROG.cbl" importDirectory="."
nativeTypeName="DFHCOMMAREA"/>
<XseSpec>
<WSBindSpec fileName="CICSPROG.wsbind"
uri="/cics/services/CICSPROG" logFileName="CICSPROG.log"
businessPgmName="CICSPROG"/>
</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>
<OutputMessage importFile="CICSPRG.cbl" importDirectory="."
nativeTypeName="DFHCOMMAREA"/>
<InputMessage importFile="CICSPRG.cbl" importDirectory="."
nativeTypeName="DFHCOMMAREA"/>
<XseSpec>
<DriverSpec fileName="CICSPRGD.cbl" driverType="WEB_SERVICES_CICS"
programName="CICSPRG" businessPgmName="CICSPROG"/>
<ConverterSpecIn fileName="CICSPRGD.cbl" programName="BUP001"/>
<ConverterSpecOut fileName="CICSPRGD.cbl" programName="BUP001"/>
<WSBindSpec fileName="CICSPROG.wsbind" uri="/cics/services/CICSPROG"
logFileName="CICSPROG.log"
mappingLevel="VENDOR" minimumRuntimeLevel="VENDOR"/>
</XseSpec>
</Operation>
</EISService>
</EISProject>
Table 1 shows the attributes for WSBindSpec.
| Fields | Description |
|---|---|
Attribute: arithExtend |
Controls the maximum size of the pack decimal variable length that is mapping to the COBOL Language structure, If set to YES, it will use 31 digits for DECIMAL and INTEGER types. If set to NO (default), the number of digits remains at 18. This option is available at all mapping levels. |
Attribute: businessPgmName |
Specifies the existing business program that CICS Web services runtime calls.
This is the program that you are enabling for processing and/or producing
XML messages to act as a Web service. This attribute is only meaningful
for CICS native conversion
and to specify target business program entry point for multiple operations
in the compiled conversion. The default value is: The Service name in the generated WSDL File truncated to 8 characters. |
Attribute: ccsid |
Specifies the CCSID that is used at run time to encode data between the application program and the Web services 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 Web service 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: contid |
If the CICS application program (specified DriverSpec/businessPgmName or WSBindSpec/businessPgmName attribute of the element) communicates via a CHANNEL, specify the name of the CONTAINER expected by program. |
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.
|
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 WSBindSpec
is specified inside the EISServiceImplementation) then the valid values
are:
If this attribute is specified in a bottom-up
(that is, the WSBindSpec is specified inside the EISService) then
the valid values are:
|
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 ".wsbind" (See Note 1). |
Attribute: inlineMaxOccursLimit |
This attribute is equivalent to the INLINE-MAXOCCURS-LIMIT parameter of the CICS Web services Assistant DFHLS2WS. 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 file The full description can be found in the CICS Transaction Server V 4.1 InfoCenter, refer to: |
Attribute: logFileName |
Specifies the name of the log file generated
by the Web Services 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 (see CICS®
Transaction Server for z/OS,
Version 4 Release 1 Information Center). Generally, it
is best to specify the highest mapping level that is available:
The use of old mapping levels is recommended only when regenerating the XML binding files for XML transformation resources that were previously deployed with an old mapping level (see CICS® Transaction Server for z/OS, Version 4 Release 1 Information Center).
|
Attribute: minimumRuntimeLevel |
Specifies the minimum CICS runtime environment that the Web service
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: nameTruncation |
Specifies how a generated
field name is shortened if it is too long for use in the specified
high-level language. This option is available at all mapping levels.
|
Attribute: overwrite |
Specifies whether to overwrite the output file if it exists. |
Attribute: pgmint |
Specify whether the CICS application program communicates via:
|
Attribute: requestChannel |
If the CICS application program (specified DriverSpec/businessPgmName or WSBindSpec/businessPgmName attribute of the element) communicates via a CHANNEL (multiple containers), specify the location of channel description document for the request. This attribute
is only valid for the CICS interpretive
(bottom-up) 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.
Note: The language structure location(s) specified
in the channel description document should be on the local file system
(For example: <structure location=”c:\MyStructures\copybook.cpy”/>)
|
Attribute: responseChannel |
If the CICS application program (specified DriverSpec/businessPgmName or WSBindSpec/businessPgmName attribute of the element) communicates via a CHANNEL (multiple containers), specify the location of channel description document for the response. This attribute
is only valid for the CICS interpretive
(bottom-up) 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.
Note: The language structure location(s) specified
in the channel description document should be on the local file system
(For example: <structure location=”c:\MyStructures\copybook.cpy”/>)
If the application uses the same set of containers for the response as was used for the request, then specify the same value as the requestChannel |
Attribute: service |
Use this parameter only when directed to do
so by IBM support. Required
Batch Options:
|
Attribute: suppressGeneration |
Indicates whether or not to suppress generation of the Web Services binding file (WSBind). |
Attribute: synconreturn |
Specifies that the remote web service can issue a syncpoint. This attribute is equivalent to the SYNCONRETURN parameter of the CICS Web services assistant wizard pages DFHLS2WS and DFHWS2LS. The implication of setting this option to YES is that the remote task is committed at return. The remote task is classified as a separate unit of work (UOW). This means that if the remote web service updates a recoverable resource and then there is a failure after it returns, the update cannot be backed out. If this option is defaulted or set to NO and the remote web service issues a syncpoint, then the remote task fails with ABEND ADPL. For more information, see description of PK406622 on http://www.ibm.com/support/docview.wss?uid=swg1PK40662 |
Attribute: transaction |
In a service provider, this parameter specifies
the 1-4 character name of an alias transaction that can start the
pipeline or run a user application to compose a HTTP response. The
value of this parameter is used to define the TRANSACTION attribute
of the URIMAP resource when it is created automatically using the
PIPELINE scan command. Acceptable characters: A-Z a-z 0-9 $ |
Attribute: uri |
Desired local URI to for the Web service, for example, "/exampleApp/InquireSingle". Note: this is different that the location of the Web service for example, http://server:port[local URI]. If you do not specify this property it must be defined at install time during manual creation of the Web service resource definitions in CICS. |
Attribute: userid |
In a service provider, this parameter specifies
a 1-8 character user ID which can be used by any Web client. For an
application-generated response or a Web service, the alias transaction
is attached under this user ID. The value of this parameter is used
to define the USERID attribute of the URIMAP resource when it is created
automatically using the PIPELINE scan command. Acceptable characters: A-Z a-z 0-9 $ @ # |
Attribute: vendorConverterName |
Specifies the program name of the main program
entry. The default value is: DriverSpec/@fileName (see Note 1) |
Attribute: xmlOnly |
If this attribute is set to true then CICS does not perform any transformations to the XML at all and instead requires that the application work with the contents of the DFHWS-BODY container directly. For a full description refer to: CICS® Transaction Server for z/OS, Version 4 Release 1 Information Center |
Note: The following WSBind default settings apply when multiple operations are present:
|
|
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
<WSBindSpec fileName="CICSPROG.wsbind" uri="/cics/services/CICSPROG"
mappingLevel="VENDOR" logFileName="CICSPROG.log" ccsid="37"
minimumRuntimeLevel="VENDOR" userid="WEBUSER" transaction="WBTR">
</WSBindSpec>