Rational Developer for System z

ItemExclude

Use this element to prevent individual data items in the COBOL structure from becoming elements in the XML message.
The exclusion rules apply as follows:
  • Only elementary items can be specified. If a group item is specified for omission, a warning message will be issued and the specification will be ignored.
  • If all elementary items in a group are omitted, the group item will automatically be omitted.
  • When an ODO (variable size repeating item) count variable is excluded, its ODO subject must also be excluded. An error message will be issued if this rule is not followed.
  • ItemExclude elements can appear in any order within ItemExclusionArray.
  • You must specify the data item name as fully qualified by dot-separated parent group names if it is required to resolve name collisions within the language structure. Otherwise, qualification is not required. For example, in the following language structure, qualification is required for both elementary items named "CODE":
    01 INPUT-MSG.
        02 COUNTRY.
          03 CODE pic 999.
        02 ACTION.
          03 CODE pic 9.
    as follows: INPUT-MSG.COUNTRY.CODE if you want to exclude that item and INPUT-MSG.ACTION.CODE if you want to exclude that item. An error message will be issued if this rule is not followed.
  • The values of the ItemExclude attributes are not case-sensitive. For example, specifying itemName="FoO.bAr" is equivalent to specifying itemName="fOo.BaR"
  • A warning message will be issued if an item that is specified in the ItemExclude cannot be found in the source language structure.

Contained by

ItemExclusionArray

Contains

None

Attributes

Fields Description

Attribute: itemName
Valid values: See Description
Required?: Yes
Default value: None

Specifies the name of the data item to be selected.

Example

For the following COBOL language structure

01 INPUT-MSG.
    02 IN-LL            PICTURE S9(3) COMP.
    02 IN-ZZ            PICTURE S9(3) COMP.
    02 IN-TRCD          PICTURE X(10).
    02 IN-CMD           PICTURE X(8).
    02 IN-NAME          PICTURE X(10).
    02 IN-EXTN          PICTURE X(10).

you can use the following settings to prevent IN-LL, IN-ZZ and IN-EXTN data items from becoming elements in the generated XML message:

  <ItemExclusionArray>
      <ItemExclude itemName="IN-LL"/>
      <ItemExclude itemName="IN-ZZ"/>
      <ItemExclude itemName="IN-EXTN"/>
  </ItemInclusionArray>

Terms of use | Feedback

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