Rational Developer for System z

InputMessage

Use this element to define messages for ONE-WAY operations or REQUEST_RESPONSE (SOLICIT_RESPONSE) operations if the input and output messages are of different types. Note that for ONE_WAY operations, you are allowed to specify only the InputMessage. OutputMessage is not allowed and will cause unpredictable results during the generation process. To compose a message from multiple data types, specify additional InputMessage elements (this capability is only supported for the IMS™ SOAP Gateway runtime). The order in which the InputMessage elements are specified in the ServiceSpecification.xml determines their order in the composite message.

Contained by

Operation

Contains

Attributes

Table 1 shows the attributes for InputMessage.

Table 1. Attribute Specifications for InputMessage
Fields Description

Attribute: name
Valid values: See Description
Required?: No
Default value: esvc

This attribute has no effect on generated artifacts. It is reserved for future use.

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

Specifies the absolute path to location and name in the file system of the synonym action XML file. The synonym action XML file contains the optional annotation information that can be present in the source of the service interface data declarations. If this attribute is not specified, the default is taken from the “-annot” parameter of the xsebatch invocation. For more information see Using source annotations to specify service interface.

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

Specifies the absolute path to location and name in the file system of the common types xml file. The common types xml file describes the common element and type information that is used in the generated WSDL and XSD schema to refer to instead of imbedding and potentially duplicating the types. If this attribute is not specified, the default is taken from the “-commtypes” parameter of the xsebatch invocation. For more information, see Commonly Used Elements and Types.

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

Specifies the directory for the source file.

The default value is: The input directory

Attribute: importFile
Valid values: See Description
Required?: Yes (unless the -s command
line option is specified)
Default value: See Description  

Specifies the file name that contains the data definition to be used in creating the Web service operation message types.
Note: Only COBOL data definitions are supported and are subject to the restrictions that are specified in the online help.

The default value is: The name provided in the xsebatch command line parameter -s.

Attribute: lowerBound
Valid values: 1 to n
Required?: No
Default value: 1  

Corresponds to the minOccurs attribute value of the xsd:element that is assigned the complexType derived from the data type specified in the following attributes: importDirectory, importFile, and nativeTypeName
Note: This attribute is ignored unless two or more InputMessages are specified.

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

Specifies the name of the data type that is to be imported from the importFile, such as DFHCOMMAREA for a CICS® COBOL application. An error message is generated on the console if a parse of the importFile does not identify the nativeTypeName as a valid data type.

The default value is: For COBOL, the name of the first available level 01 data item name.

Attribute: upperBound
Valid values: 1 to n, -1 (infinite)
Required?: No
Default value: 1  

Corresponds to the minOccurs attribute value of the xsd:element that is assigned the complexType derived from the data type specified in the following attributes: importDirectory, importFile, and nativeTypeName
Note: This attribute is ignored unless two or more InputMessages are specified.

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

Specifies the desired tag name of the xsd:element that is assigned the complexType derived from the data type specified in the following attributes: importDirectory, importFile, and nativeTypeName
Note: This attribute is ignored unless two or more InputMessages are specified.

Example

Figure 1 is an example of InputMessage element.
Note: Another example of an Input message is in Specification of Multiple Response Language Structures.
Figure 1. Example of InputMessage Element
<InputMessage name="PhoneBookRequest" importDirectory="." importFile="Ex01z.cbl" 
      commTypesFile=c:/common/commtypesSample.xml nativeTypeName="input-msg">
   <RedefinesArray>
      <RedefineSelection redefine="input-msg.redParent.redefd" 
               useRedefinition="input-msg.redParent.redefd2"/>
   </RedefinesArray>
   <ItemSelectionArray>
       <ItemSelection itemName="input-msg.redParent"/>
       <ItemSelection itemName="input-msg.in-extn"/>
       <ItemSelection itemName="input-msg.in-zip"/>
       <ItemSelection itemName="input-msg.in-ll"/>
   </ItemSelectionArray>
</InputMessage>

Terms of use | Feedback

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