MessageSpec

Edit online

Use this element to specify data structures for conversion by the XML transformation.

The XML transformation is supported in CICS® Transaction Server 4.1 and later. MessageSpec elements apply to:

conversion from XML documents to data structures
conversion from data structures to XML documents

Note: MessageSpec CANNOT be used with:

InputMessage
OutputMessage
InputOutputMessage (Deprecated)
The InputOutputMessage element is being deprecated and should not be used. Instead use the InputMessage and OutputMessage elements and specify identical parameters.

Contained by

Operation

Contains

Attributes

Table 1 shows the attributes for MessageSpec.

Table 1. Attribute Specifications for MessageSpec
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 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 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 language data definitions to be used in creating the XML data 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: 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.

Example

Figure 1 is an example of the MessageSpec element.

Figure 1. Example of MessageSpec Element

<MessageSpec name="convertThis" importDirectory="." importFile="sample.cbl" 
         nativeTypeName="input-struc">
      <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>
   </MessageSpec>