Rational Developer for System z, Version 7.6

CodegenProperty

Use this element in the PlatformProperties.xml document to specify the properties for generating the converter code, or in the ServiceSpecification.xml document to override the code generation properties that you set in PlatformProperties.xml.

Contained by

Contains

None

Attributes

Start the value of the name attribute with com.ibm.etools.xmlent.ui.

Table 1 shows the attributes for CodegenProperty.

Table 1. Attribute Specifications for CodegenProperty
Fields Description

Attribute:
COBOL_COMPILER_LEVEL
Valid values: 3.1, 3.2, 3.3, 3.4, 4.1  
Default value: 3.3

The value of this attribute directs the COBOL converter generators to generate code based on a specific level of the Enterprise COBOL compiler. For example, data size limitations may differ from one compiler version to the other. Setting Enterprise COBOL compiler version to 3.4, for example, allows maximum XML message size of 32 MB, whereas a lower version of the compiler allows only 16 MB (see Increase Message Size of XML Messages (Request and Response)). If the converter generator determines that the maximum message size can be exceeded, an error message is displayed and service generation is aborted. If an invalid compiler version value is specified, a warning message is generated and the rest of the generation assumes 3.3 as the value.

Selecting version 4.1 enables the XML Parsing option, see the CodegenProperty attribute GEN_COBOL_XMLPARSE_OPTION .

Attribute: GEN_AUTH_NAME
Valid values: See Description  
Default value: WSED

The generated author name. It must be formed according to COBOL language rules.

Attribute: GEN_BIDI_HOST
Valid values: See Description  
Default value: None

The values for this attribute define the bidirectional language characteristics of the host data. The transformation is done from request XML data with characteristics specified by GEN_BIDI_OUT to the host data with characteristics specified by this attribute after the data is populated and converted to the appropriate bidirectional language host page. See Supported code pages (CCSIDs).

The values for this attribute are the same as in the description for GEN_BIDI_IN. If this attribute is specified, you are also required to specify GEN_BIDI_IN or GEN_BIDI_OUT or both.

Note: If you do not specify either of the required attributes, no bidirectional language transformation will be performed.

Attribute: GEN_BIDI_IN
Valid values: See Description  
Default value: None

The values for this attribute define the bidirectional language characteristics of the request XML data. The transformation is done from source messages with these characteristics to the host data with characteristics specified by GEN_BIDI_HOST after the data is populated and converted to the appropriate bidirectional language host page.

See Supported code pages (CCSIDs) If this attribute is specified, you are also required to specify GEN_BIDI_HOST.

Note: If you do not specify either of the required attributes, no bidirectional language transformation will be performed.
The values for this attribute can be formed by concatenating the appropriate transformation attributes as follows:
  • "VISUAL" or "LOGICAL" for Text type
  • "LTR" or "RTL" for Text orientation
  • "SYMSWAP" or blank for Symmetric swapping
  • * "NUMSWAP" or blank for Numeric swapping

For example: VISUALRTLSYMSWAP You can specify the transformation attributes in any order.

Attribute: GEN_BIDI_OUT
Valid values: See Description  
Default value: None

The values for this attribute define the bidirectional language characteristics of the response XML data. The transformation will be done from host data with characteristics specified by GEN_BIDI_HOST to the response XML data with characteristics specified by this attribute before the host data is converted to the response code page. See Supported code pages (CCSIDs).

If this attribute is specified, you are also required to specify GEN_BIDI_HOST. If you do not specify either of the required attributes, no bidirectional language transformation will be performed. The values for this attribute are the same as in the description for GEN_BIDI_IN.

Attribute:
GEN_COBOL_XMLPARSE_OPTION
Valid values: COMPAT, XMLSS      
Default value: COMPAT

The value of this attribute directs the COBOL converter generators to generate code based on the XML parser selected for the COBOL XML PARSE statement.

This option is only valid if COBOL_COMPILER_LEVEL is set to 4.1.

Attribute:
GEN_COMMENT_IN_XSD
Valid values: See Description  
Default value: false

This attribute has an effect only when you are generating a Web service using the bottom-up method and you are using compiled XML conversion.

When this attribute is set to TRUE, the comments from the COBOL source code file are generated as annotation documentation in the generated XSD and WSDL files.

See Including COBOL source code comments in generated XSD and WSDL files for more information about this attribute.

Attribute:
GEN_CONVERSION_TYPE
Valid values: See Description  
Default value: compiled

Specifies the type of conversion services that are generated.
The value interpretive is valid only for the following types of single-service projects:
  • Web services for CICS® project
See Batch processor options applicable for interpretive conversion type.

For the remaining types of single-service projects the value of this attribute is always assumed to be compiled, even if you specify interpretive.

When this attribute is set to interpretive, you can also specify the name of the log file generated by the Web Services Assistant, using the logFileName attribute in the WSBindSpec element of ServiceSpecification.xml.

Attribute: GEN_CP_LIST
Valid values: See Description  
Default value: 1140

Code page for the host converter program. See Supported code page combinations.

Attribute: GEN_DEC_COMMA
Valid values: See Description  
Default value: false

This attribute is used to control the format of the decimal fraction separator. If this option is set to true, the decimal fraction separator is set to be a comma.

Attribute:
GEN_ERROR_FEEDBACK_FILE_PATH
Valid values: See Description  
Default value: 1140

This attribute has an effect only when you are generating source code for a Web service using the bottom-up method and using compiled XML conversion.

When this attribute is specified, the source code generator validates the syntax of the main COBOL input file and its included COBOL files and, if any COBOL syntax errors are detected, writes appropriate error information into the output file that you specify.

When you use this attribute:
  • Specify the name attribute to enable this option.
  • In the value attribute, specify an output file path or file name.

See Logging syntax errors detected in COBOL input files for more information about this attribute.

Attribute:
GEN_ELEMENT_FORM_QUALIFIED
Valid values: See Description  
Default value: true

The value of this attribute determines the value of the elementFormQualified attribute in XML Schemas generated by the tool. This option only affects the "Compiled XML Conversion" conversion type.

Attribute: GEN_FLAT_GEN
Valid values: See Description  
Default value: false

This attribute is used to control whether generated XML schemas have flat or hierarchical structure. If this option is set to true, the generators are set to generate flat schemas.

Attribute: GEN_IN_CP_LIST
Valid values: See Description  
Default value: 1140

Code page for the request (input) message. See Supported code pages (CCSIDs).
Note: If you are generating artifacts for the IMS™ SOAP Gateway, you must specify UTF-8 (value="1208") as Code page for the request (input) message (GEN_IN_CP_LIST) and UTF-8 (value="1208") as Code page for the response (output) message (GEN_OUT_CP_LIST). Any other values are not allowed and will cause a runtime error if specified.

Attribute:
GEN_IMS_MESSAGE_TYPE
Valid values: ASYNC | SYNC  
Default value: ASYNC

The value of this attribute directs the COBOL and PL/I XML converter generators to generate code that is compatible with the IMS Asynchronous Callout (ASYNC) or IMS Synchronous Callout (SYNC) functions.

Attribute:
GEN_OMIT_XML_NAMESPACES
Valid values: true | false  
Default value: false

If "true" is specified as the value of this attribute, the XML Schema and XML converter generators will avoid the use of XML Namespaces in XML instances. The specific effects of this option are: XML Schemas will have a null target namespace, and the response XML converter will omit namespaces from the generated XML.
Note: This option should be set to true when generating artifacts for the IMS Web 2.0 runtime.

Attribute: GEN_OUT_CP_LIST
Valid values: See Description  
Default value: 1140

Code page for the response (output) message. See Supported code page combinations.
Note: If you are generating artifacts for the IMS SOAP Gateway, you must specify UTF-8 (value="1208") as Code page for the request (input) message (GEN_IN_CP_LIST) and UTF-8 (value="1208") as Code page for the (output) message (GEN_OUT_CP_LIST). Any other values are not allowed and will cause a runtime error if specified.

Attribute: GEN_OUT_FILTER
Valid values: See Description  
Default value: true

This attribute is used to control whether the response XML converter will filter characters in the language structure that are illegal in XML 1.0.

Attribute: GEN_OUT_HALT
Valid values: See Description  
Default value:   

This attribute is used to control whether the response XML converter will halt and report an error if characters illegal in XML 1.0 are found in the language structure.

Attribute: GEN_PROG_NAME
Valid values: See Description  
Default value: 1140

The generated program name. It must be formed according to COBOL language rules. The default is set to the COBOL copybook (or source program) file name shortened to 7 characters and converted to uppercase.

Attribute:
GEN_SHORT_TYPE_NAMES
Valid values: See Description  
Default value: false

The value of this attribute controls how complex type names are generated from the COBOL group items. The value of "true" will cause the type name  to be shortened to contain just the name derived from the group name itself and not the names of all the parent groups. The value of "false" will cause the type name to contain the names derived from all the parent groups. This attribute has no effect on top-down or meet-in-the-middle scenarios.

Attribute: GEN_SOAP_VERSION
Valid values: See Description  
Default value: See Description

The value of this attribute controls what version of the SOAP protocol binding is generated by the IBM® Rational® Developer for System z® in a WSDL file. The valid values for this option are "1.1", "1.2", and "ALL". When a particular version is specified, the SOAP binding conforming to that SOAP protocol version is generated in the WSDL file. If ALL is selected , both bindings are generated in the WSDL file.

If this option is not specified by the user, then the default value of this option depends on the setting of the GEN_WSDL_VERSION: If the requested WSDL version is set to 1.1, then the default value of the SOAP version is set 1.1. If the requested WSDL version is set to 2.0, then the default value of the SOAP version is set to 1.2.

In addition, specifying this option forces the setting of the minimumRuntimeLevel to a value of 2.0. For additional information, see the description of the runtimeLevel attribute (runtimeLevel) in the WSBindSpec function.
Note: This option affects only CICS Web services interpretive bottom-up scenario. For more information on the behavior of the WSBind file with various SOAP versions, see the CICS TS 3.2 documentation.

Attribute:
GEN_TOTAL_FRACTION_DIGITS
Valid values: See Description  
Default value: false

This attribute is used to control whether generated XML schemas have totalDigits and fractionDigits for COBOL numeric data types. If this option is set to true, the generators are set to generate total/fractionDigits. The following rules are applied if the user chooses for generation of total/fractionDigits
  • For COBOL decimal types, generate both totalDigits and fractionDigits. For example:
    • pic 9(13)v9(2): totalDigits = 15, fractionDigits = 2
    • pic s99v9: totalDigits = 3, fractionDigits = 1
  • For COBOL integer types, generate only totalDigits. For example
    • pic 99 or 99v or s99: totalDigits = 2
  • Not generated, if the COBOL numeric data item has any "leading or trailing zeroes". For example:
    • pic P9 or 9PP.

Attribute:
GEN_USE_MTOM_XOP
Valid values: true | false  
Default value: false

The value of this attribute indicates to the Batch Processor whether or not to generate Web service artifacts compatible with MTOM (Message Transformation Optimization Mechanism)/XOP (XML-binary Optimization Package). When the value of this attribute is true, the behavior of the Batch Processor is modified in the following ways:
  • 01 level language structures specified on the InputMessage and OutputMessage elements are treated as simple 01 level character arrays before being passed to DFHLS2WS; this occurs so that they each language structure is represented as a single xsd:base64binary typed element in the Web service description.
  • The value of the attribute XseSpec/WSBindSpec/@charVarying is assumed to be “true”.
Note: This attribute only affects the output of the batch processor when GEN_CONVERSION_TYPE = "interpretive" and the ServiceSpecification.xml/EISService element is used (bottom-up).

For additional description, see Generate CICS MTOM/XOP Web Service (Bottom-Up)

Attribute:
GEN_VALIDATE_ROOT_IN_NS
Valid values: See Description  
Default value: false

The value of this attribute controls whether the namespace name of the top level element of request XML instance documents will be validated against the namespace name specified in the request XML schema. This option only affects the "Compiled XML Conversion" conversion type.

Attribute: GEN_WSDL_VERSION
Valid values: See Description  
Default value: 1.1

The value of this attribute controls what version of the WSDL (Web service description) is generated by IBM Rational Developer for System z. Currently the valid values for this option are "1.1" and "2.0". This option affects only CICS Web services interpretive bottom-up scenario.
Note: Specifying 2.0 as WSDL version forces the minimum runtime level option to be set to 2.0 regardless of the setting of the WSBind mapping level. For more information, see the description of the mappingLevel attribute ( mappingLevel) and the runtimeLevel attribute (runtimeLevel) in the WSBindSpec function.

Attribute: GEN_XSD_GROUPS
Valid values: See Description  
Default value: false

This attribute is used to control generation of groups in the XML schema. If this option is set to true, the XML schema can contain schema groups and grouprefs.

Attribute:
INIT_EMPTY_ITEMS_IN_INTERFACE
Valid values: See Description  
Default value: false

In contrast to the INIT_OMITTED_ITEMS_IN_INTERFACE (the next attribute described in this table), this attribute enables initialization for data items in the request language structure that you have included in the Web service input data structure.

This attribute applies only to the bottom-up scenario for generating a Web service, and apply only if you specify Compiled XML Conversion.

When this attribute is enabled, VALUE clauses in the request language structure that you specified for the new Web service are given effect by initialization code that is executed before the new Web service invokes the existing COBOL application (service provider application or service requester application.

However, even when this attribute is enabled, it does not affect a particular COBOL data item unless the corresponding XML element in the request XSD Schema data structure is empty.

VALUE literals must be defined in one line. They must not be continued.

See Initializing data items in the COBOL application's input data structure for more information about this attribute.

Attribute:
INIT_OMITTED_ITEMS_IN_INTERFACE
Valid values: See Description  
Default value: false

In contrast to the INIT_EMPTY_ITEMS_IN_INTERFACE (the previous attribute described in this table), this attribute enables initialization for data items in the request language structure that you have excluded from the Web service input data structure.

This attribute applies only to the bottom-up scenario for generating a Web service, and apply only if you specify Compiled XML Conversion.

When this attribute is enabled, VALUE clauses in the request language structure that you specified for the new Web service are given effect by initialization code that is executed before the new Web service invokes the existing COBOL application (service provider application or service requester application).

VALUE literals must be defined in one line. They must not be continued.

See Initializing data items in the COBOL application's input data structure for more information about this attribute.

Example

Figure 1 is an example of CodgenProperty elements within the CodgenPropertyArray element.
Figure 1. Example of CodegenProperty Elements
<CodegenPropertyArray type="Cobol">
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_PROG_NAME" value="XCNV"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_CONVERSION_TYPE" value="interpretive"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_AUTH_NAME" value="WSED"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_DEC_COMMA" value=" false"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_FLAT_GEN" value=" false"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.COBOL_COMPILER_LEVEL" value="3.4"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_SHORT_TYPE_NAMES" value="true"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_WSDL_VERSION" value="2.0"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_SOAP_VERSION" value="1.2"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_TOTAL_FRACTION_DIGITS" value="false"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_COMMENT_IN_XSD" value="true"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.GEN_ERROR_FEEDBACK_FILE_PATH" value="c:\Documents 
          and Settings\My Documents\ErrorFeedBack\SyntaxError.xml"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.INIT_EMPTY_ITEMS_IN_INTERFACE" value="true"/>
     <CodegenProperty name="com.ibm.etools.xmlent.ui.INIT_OMITTED ITEMS_IN_INTERFACE" value="true"/>
</CodegenPropertyArray>

Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)