IBM Support

PH51217: Truncation of API response data.

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as unreproducible in next release.

Error description

  • After updating to z/OS Connect V3.0.59.0 truncation of the API
    response data was seen, when the response ended with an array
    that did not have data for all occurrences.
    
    A response array ends with the following at V3.0.47.0:
    
               "ACCT_CUST_EXTD_DETAILS": {
                   "CUST_EXTD_DETAILS": [
                       {
                           "CUST_NUM": CUST1,
                           "CUST_FILLER": ""
                       },
                       {
                           "CUST_NUM": CUST2,
                           "CUST_FILLER": ""
                       },
                       {
                           "CUST_NUM": null,
                           "CUST_FILLER": null
                       },
                       {
                           "CUST_NUM": null,
                           "CUST_FILLER": null
                       }
    
    
    After updating to V3.0.59.0, the response is truncated to:
    
                   "CUST_EXTD_DETAILS": [
                       {
                           "CUST_NUM": CUST1,
                           "CUST_FILLER": ""
                       },
                       {
                           "CUST_NUM": CUST2,
                           "CUST_FILLER": ""
                       }
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED: All users of z/OS Connect V3.0.              *
    ****************************************************************
    * PROBLEM DESCRIPTION: When the response data structure from a *
    *                      CICS, IMS, or MQ application is         *
    *                      truncated, z/OS Connect does not        *
    *                      generate JSON for fields that do not    *
    *                      have bytes provided in the response.    *
    ****************************************************************
    When two new IMS advanced options, "Truncate last character
    field in IMS large data structure", and "Truncate last
    character field in IMS message segment", were introduced in
    z/OS Connect V3.0.59.0, general omission of JSON properties for
    fully truncated fields was added. Omission of JSON tags for
    fully truncated fields causes issues for existing API clients
    that do not expect the JSON properties to be omitted.
    

Problem conclusion

Temporary fix

Comments

  • The original product behavior of generating JSON properties
    with null values for fully truncated fields in response data
    structures has been restored.
    
    For example, assume the following response data structure:
    
    01 PURCHASEORDER.
     02 ORDERDATE PIC X(64) DISPLAY.
     02 SHIPTO.
        ...
     02 BILLTO.
        ...
     02 ITEM OCCURS 3 TIMES.
      03 PARTNUM PIC X(32) DISPLAY.
      03 PRODUCTNAME PIC X(32) DISPLAY.
      03 QUANTITY PIC S9(31) COMP-3.
      03 USPRICE PIC S9(25)V9(6) COMP-3.
      03 AVAILABLE PIC X DISPLAY.
      03 DATEAVAIL PIC X(64) DISPLAY.
    
    If bytes for only 2 of the 3 occurrences of ITEM are provided,
    JSON with null values will be generated for the third
    occurrence.
    
    {
      "PURCHASEORDER": {
        "SHIPTO": {...},
        "BILLTO": {...},
        "ITEM": [
          {
            "AVAILABLE": "Y",
            "QUANTITY": 1,
            "USPRICE": 100.11,
            "PARTNUM": "111-AA",
            "PRODUCTNAME": "Widget 1",
            "DATEAVAIL": "2100-01-11"
          },
          {
            "AVAILABLE": "Y",
            "QUANTITY": 2,
            "USPRICE": 200.22,
            "PARTNUM": "222-AA",
            "PRODUCTNAME": "Widget 2",
            "DATEAVAIL": "2200-02-22"
          },
          {
            "AVAILABLE": null,
            "QUANTITY": null,
            "USPRICE": null,
            "PARTNUM": null,
            "PRODUCTNAME": null,
            "DATEAVAIL": null
          }
        ]
      }
    }
    
    The fix for this APAR is expected to be delivered by the PTF for
    z/OS Connect V3.0.64.0 (PH51090).
    

APAR Information

  • APAR number

    PH51217

  • Reported component name

    Z/OS CONNECT EE

  • Reported component ID

    5655CE300

  • Reported release

    000

  • Status

    CLOSED UR1

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2022-12-01

  • Closed date

    2022-12-06

  • Last modified date

    2022-12-06

  • APAR is sysrouted FROM one or more of the following:

  • APAR is sysrouted TO one or more of the following:

Fix information

  • Fixed component name

    Z/OS CONNECT EE

  • Fixed component ID

    5655CE300

Applicable component levels

[{"Business Unit":{"code":"BU029","label":"Software"},"Product":{"code":"SSVVFY","label":"z\/OS Connect Enterprise Edition"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"3.0"}]

Document Information

Modified date:
06 December 2022