A fix is available
APAR status
Closed as program error.
Error description
Warning Limit Change
Local fix
Problem summary
**************************************************************** * USERS AFFECTED: All CICSPlex SM V4R1M0 Users * **************************************************************** * PROBLEM DESCRIPTION: - The CPSM API has been updated to * * allow a user program to ask for the * * count of records that will be * * returned for a GET request for a * * CICS resource table, without * * collecting the full data. * * * * The CMCI has been updated to use * * this new function to support the * * CPSM WUI DEFAULTWARNCNT * * initialization parameter, when the * * CMCI runs in a WUI server. This * * ability has not been extended for * * the CMCI running in an SMSS system. * * * * * * - A CMCI request returning an error * * message as a response may contain a * * badly formatted errorInfo tag. * **************************************************************** * RECOMMENDATION: After applying the PTFs that resolve this * * APAR, all CMASes, MASes, WUI servers and * * SMSS systems must be restarted. Note that * * the restarts do not need to occur at the * * same time. However, all MASes should be * * restarted with the updated code before any * * requests that use the TEST parameter of the * * API GET command or the CMCI record warning * * count are directed to them. * * * * In addition, before any requests that use * * the TEST parameter of the API GET command or * * the CMCI record warning count that originate * * through a CPSM V4R1M0 CMAS are directed to a * * MAS connected to a CPSM V3R1M0 or V3R2M0 * * CMAS, the PTFs that resolve APAR PK97246 * * (CPSM V3R1M0) and APAR PK97247 (CPSM V3R2M0) * * should be applied and the MASes restarted * * with the updated code. * **************************************************************** - When a GET request is issued through the CPSM API, the records retrieved are stored in a result set in dataspace storage that is owned by the CPSM ESSS. This storage remains allocated until the user program reuses or discards the result set, or disconnects from the API. To protect against auxiliary storage overuse, the CMAS will terminate itself if it approaches the limits of this storage area, as defined by the MAXAUXTOTL and MAXAUXCPSM EYUPARMs. To minimize the chance of this happening through the WUI, the DEFAULTWARNCNT initialization parameter was added to provide an artificial limit that the WUI could check the expected record count against. Any request expected to exceed this value could either be instantly failed or postponed until the user decided whether to accept the request or not. Currently CPSM API programs and the CMCI have no such mechanism. - For CMCI responses that are not HTTP 200 (OK) responses a response body containing the XML error tag is returned. This HTTP 403 response body for example, looks like this: <?xml version="1.0" encoding="UTF-8"?> <error message_id="DFHWU4301" connect_version="0410"> <title> 403 CICS management client interface HTTP Error</title> <short>An error has occurred in the CICS management client interface. The request has been denied as it exceeded a resource limit.</short> <full> The requested record count will exceed the current default warning count limit.</full> <errorInfo name="current_record_count">3</errorInfo> <errorInfo name="default_warning_count">2</errorInfo> </error> Within the error tag, the errorInfo tag contains additional information regarding why this specific request failed. A logic error results in invalid storage being referenced when building these tags, which can result in the errorInfo tags containing invalid or badly formatted data.
Problem conclusion
- The CPSM API has been updated to allow a new TEST parameter on the GET command when the object is a CICS resource table and the result set token passed on the request is zero. When TEST is specified on a GET, CPSM will collect a small subset of the record, count the number of records returned, release the storage used to perform this function, and then return the retrieved record count to the caller. No result set is returned to the caller. TEST can be used with the SCOPE, PARM and CRITERIA parameters, and reflects their limits in the record count. An example of an API command to utilize this new function is as follows: EXEC CPSM GET OBJECT(<object>) TEST COUNT(<count>) RESULT(<result>) THREAD(<thread>) RESPONSE(<response>) REASON(<reason>) Note that in the above example, the object being requested must be a CICS resource table and the result set token must be zero: - If the object is not a CICS resource table, a RESPONSE/REASON of INVALIDPARM/OBJECT will be returned. - If the result set token is not zero, a RESPONSE/REASON of INVALIDPARM/RESULT will be returned. When the CMCI runs in a WUI server, it utilizes the TEST parameter of the GET command and the WUI DEFAULTWARNCNT initialization parameter when CICS resource records are requested. If DEFAULTWARNCNT is set to a non-zero value, the CMCI will issue a GET request with the TEST operand to get the expected record count, and compare this with the DEFAULTWARNCNT value. If the value is exceeded the CMCI will return a HTTP 403 response documenting both the current record count value and the DEFAULTWARNCNT value. If DEFAULTWARNCNT is set to zero, the CMCI will issue a GET without the TEST parameter, and return the appropriate records to the caller. The HTTP 403 response body is similar to the following: <?xml version="1.0" encoding="UTF-8"?> <error message_id="DFHWU4301" connect_version="0410"> <title> 403 CICS management client interface HTTP Error</title> <short>An error has occurred in the CICS management client interface. The request has been denied as it exceeded a resource limit.</short> <full> The requested record count will exceed the current default warning count limit.</full> <errorInfo name="current_record_count">3</errorInfo> <errorInfo name="default_warning_count">2</errorInfo> </error> The CMCI DEFAULTWARNCNT behaviour differs from the WUI in a few important ways: - The CMCI can provide the DEFAULTWARNCNT check on all CICS resource tables. The WUI can provide this check only for resource tables that have associated CRES* records. - The CMCI will respond with an HTTP 403 response for any request that satisfies the above criteria. The WUI uses the RESOURCELIMIT initialization parameter to decide whether to fail the request or to warn the user and let them accept the request. - The WUI supports setting different DEFAULTWARNCNT values for user groups. The CMCI does not support that. Once a user reaches the DEFAULTWARNCNT limit and has received the HTTP 403 response from the CMCI, they have the option to modify the request to reduce the number of records received. The options for doing this are changing the SCOPE, CRITERIA and in some cases the PARAMETER of the request. The SUMMONLY, INDEX and COUNT URI options do not change the number of records requested. - The CMCI has been updated to ensure that the appropriate storage is referenced when building errorInfo tags.
Temporary fix
FIX AVAILABLE BY PTF ONLY
Comments
APAR Information
APAR number
PK91877
Reported component name
CICS TS Z/OS V4
Reported component ID
5655S9700
Reported release
60M
Status
CLOSED PER
PE
NoPE
HIPER
NoHIPER
Special Attention
NoSpecatt
Submitted date
2009-07-21
Closed date
2009-10-01
Last modified date
2009-11-04
APAR is sysrouted FROM one or more of the following:
APAR is sysrouted TO one or more of the following:
UK50584 UK50585
Modules/Macros
DESWUCPA DESWUEYU DESWUGC1 DESWUIN DESWUIPG DESWUI2E DESWUPFM DESWURQP DESWURSF DESWURSM DESWUSCH DESWUSTG DESWUWEB DESWUXML DFHSMTAB DFHWUCPA DFHWUEYU DFHWUE2I DFHWUGC1 DFHWUINT DFHWUIN1 DFHWUIN2 DFHWUIPG DFHWUIPI DFHWUIP1 DFHWUIP2 DFHWUIP3 DFHWUIP4 DFHWUIP5 DFHWUIP6 DFHWUI2E DFHWUPFM DFHWURP DFHWURQP DFHWURSF DFHWURSM DFHWUSCH DFHWUSTG DFHWUTRI DFHWUWEB DFHWUXML DFHWUXST DYU0MOMB DYU0VAGT EYUCXXRS EYUQXXRC EYUTACMD EYUTMOMI EYUTMOSD EYUTRDIR EYUTVOSX EYUUACMD EYUUAGBL EYUUXXFI EYUUXXRS EYUUXXTC EYU0MOMB EYU0NQHT EYU0VAGT EYU0XDOV EYU0XDP1
SC34703100 | GC34699500 | SC34704500 |
Fix information
Fixed component name
CICS TS Z/OS V4
Fixed component ID
5655S9700
Applicable component levels
Fix is available
Select the PTF appropriate for your component level. You will be required to sign in. Distribution on physical media is not available in all countries.
[{"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"SSGMGV","label":"CICS Transaction Server"},"Component":"","ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"4.1","Edition":"","Line of Business":{"code":"LOB35","label":"Mainframe SW"}},{"Business Unit":{"code":"BU054","label":"Systems w\/TPS"},"Product":{"code":"SG19M","label":"APARs - z\/OS environment"},"Component":"","ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"4.1","Edition":"","Line of Business":{"code":"","label":""}}]
Document Information
Modified date:
04 November 2009