Rational Developer for System z

DriverSpec

Use this element of the ServiceSpecification.xml document to specify the generation options for the converter driver program
Note: In the top-down scenario the DriverSpec specifies the file that contains the entire conversion package (driver, converters, and utility programs).

Contained by

XseSpec

Contains

None

Attributes

Table 1 shows the attributes for DriverSpec.

Table 1. Attribute Specifications for DriverSpec
Fields Description

Attribute: businessPgmName
Valid values: See Description
Required?: No
Default value: See Description

Specifies the existing business program that the XML converters call. This is the program that you are enabling for processing and/or producing XML messages (to act as a Web service, for example.)
The default value is: Data source file name up to 7 characters.
Note:
  1. If the name is longer than 7 characters only the first 7 characters are used to form the default. The specified name must follow COBOL conventions for the program name.
  2. If the driver type is XML_TRANSFORM_CICS, the value of this attribute is ignored.

Attribute: driverType  
Valid values: BATCH | IMS_SOAP |
  IMS_INFO_20 |   SOAP_FOR_CICS  |
  WEB_SERVICES_CICS |
  XML_TRANSFORM_CICS
Required?: No
Default value: SOAP_FOR_CICS

Specifies the type of drivers and converters to generate for a specific subsystem (such as CICS®, IMS™, TSO);
  • BATCH - Basic converter and driver types running in batch, in TSO, or in z/OS® UNIX System Services.
  • IMS_SOAP - XML Converters, XML Schemas, WSDL, and Correlator file for deployment into the IMS Enterprise Suite SOAP Gateway runtime environment.
  • IMS_INFO_20 - XML Converters, XML Schemas and Correlator file for deployment into the IMS Web 2.0 runtime environment.
  • SOAP_FOR_CICS - Converters and drivers to be deployed into a SOAP for CICS runtime environment.
  • WEB_SERVICES_CICS - Converters and drivers to be deployed into a CICS Web services runtime environment.
  • XML_TRANSFORM _CICS - Converters and drivers to be deployed as a CICS XML TRANSFORM runtime resource for Vendor transformation.

Attribute: fileName  
Valid values: See Description
Required?: No
Default value: See Description

Specifies the name of the output file.

The default value is: Data source file name concatenated with "D"

Attribute: fileNamePrefix
Valid values: See Description.
Required?: No
Default value: See Description.

Specifies the prefix used to form the names of the generated conversion source packages. A conversion source package is a single COBOL or PL/I source file that contains the generated conversion programs for converting from XML data to language data and from language data to the XML data. For Web services scenarios these packages may contain SOAP header and SOAP fault conversion code and other utility programs (if supported by a specific scenario).

The default value is the name of the input WSDL file up to 6 characters, excluding the file extension.

Note:
  • If the name of the input WSDL file is longer than 6 characters, then the first 6 characters are used to form the default name.
  • To avoid name collisions for multiple conversion source packages, successive package names are formed by appending a hexadecimal ordinal to the value of fileNamePrefix, up to 7 characters, to distinguish it from previously generated packages.1. If the number of possible distinct package names is exhausted then the batch processor terminates with error CRRZX0130E.
  • This attribute is supported only if the driver type is IMS_SOAP. For all other driver types the value of this attribute is ignored.

Attribute: overwrite
Valid values: true | false
Required?: No
Default value: true

Specifies whether to overwrite the output file if it exists.

Attribute: programName
Valid values: See Description
Required?: No
Default value: See Description

Specifies the program name of the main program entry.

The default value is: Value of the CodegenProperty GEN_PROG_NAME concatenated with "D".

Attribute: suppressGeneration
Valid values: true | false
Required?: No
Default value: false

Indicates whether or not to suppress generation of the compiled XML converter driver.

Attribute: xmlContainerName
Valid values: See Description
Required?: No
Default value: xmlCont

For XML_TRANSFORM _CICS type converters, specifies the name of the CICS container that carries the XML document. Depending on the direction of the conversion it can contain ether the result of the conversion or the XML document to be converted. The name must be a valid CICS container name of 16 characters or less.

Attribute: dataContainerName  
Valid values: See Description
Required?: No
Default value: xmlCont

For XML_TRANSFORM _CICS type converters, specifies the name of the CICS container that carries the language data. Depending on the direction of the conversion it can contain ether the result of the conversion or the language data to be converted. The name must be a valid CICS container name of 16 characters or less.
1 The attribute fileNamePrefix defaults to a portion of the WSDL file name only if the attribute is not specified from DriverSpec. For example if @fileNamePrefix="HELLO" but the WSDL file name is MyService.wsdl, the package names will be HELLOD.pli through HELLOFFD.pli.

Example

Figure 1 is an example of DriverSpec element.
Figure 1. Example of DriverSpec Element
<DriverSpec fileName="IMSPHBKD.cbl" driverType="WEB_SERVICES_CICS"
                               programName="XCNVD" businessPgmName="IMSPHBK" />

Feedback