IBM Support

Collect troubleshooting data for web services, XML, and JSON transformation problems in CICS TS for z/OS

Troubleshooting


Problem

You are having a web services, XML, or JSON transformation problem in CICS Transaction Server for z/OS (CICS TS). You would like to know what documentation you must collect (MustGather) so that the CICS Support team can diagnose your problem. If you gather this documentation before contacting support it will expedite the troubleshooting process, and save you time.

Resolving The Problem

For the most up-to-date documentation, refer to Collecting CICS troubleshooting data (MustGather) for IBM Support in the CICS TS documentation. You will find the General information you should gather for every type of problem followed by the Component-specific information which includes Troubleshooting data for web services, XML, and JSON transformation problems.

The following is the original MustGather information:





Collecting general information for all problems

If you have already contacted IBM Support, you can continue on to the component-specific MustGather information. Otherwise, go to Collect troubleshooting data for CICS products - Read first.

Collecting data for web service, XML, or JSON transformation problems


If you are a new user to web services, you should run the web services sample application that is distributed with CICS. The CICS sample requires that you use WebSphere Application Server or something similar as the client platform. If you do not have WebSphere Application Server or something similar, you can do a simple test using free Eclipse software to ensure web services is set up correctly in your CICS region. Afterwards, gather the following documentation for your web services problem and contact IBM support.

Note that there are several parts to web services in CICS and each is diagnosed with different information. For problems with the Mobile Extensions Feature Pack, that provides support for JSON (JavaScript Object Notation) web services, for CICS TS 4.2 and CICS TS 5.1, see Collect troubleshooting data for CICS Transaction Server for z/OS Feature Pack for Mobile Extensions V1.0. For problems with JSON web services in CICS TS 5.2, refer to the information below.

Required (MustGather) data:
  • For problems with the CICS web services assistant, the CICS XML assistant or the CICS JSON assistant that include problems with DFHWS2LS, DFHLS2WS, DFHSC2LS, DFHLS2SC, DFHJS2LS or DFHLS2JS provide:
    • A description of the problem.
    • The source document. For DFHLS2WS, DFHLS2SC and DFHLS2JS, this includes the language structure (copybook). For DFHWS2LS, DFHSC2LS or DFHJS2LS, this includes the Web Services Description Language (WSDL) file, XML schema or JSON schema used as input to the assistant and all external WSDL and schema documents that get included in it.
    • A list of the parameters that you specified.
    • The log file generated by DFHWS2LS, DFHLS2WS, DFHSC2LS, DFHLS2SC, DFHJS2LS or DFHLS2JS.
  • For problems with the configuration of a pipeline used to handle web service requests you should provide the pipeline configuration file being used. This includes problems such as handler programs not being called, or problems installing and manipulating pipelines using CEMT.
  • For web services runtime problems provide:
    • An MVS system dump if one is taken. If you receive message DFHPI1007 or DFHPI1008 and a dump is not taken, enter CEMT SET SYD(xxxxx) SYS MAX(1) ADD where xxxxx is the CICS message without the DFH to request a dump when you receive the message. Then recreate the problem or wait for it to occur.
    • CICS internal trace that is included in the MVS system dump when tracing is active. The trace should be at least 10240K and when possible the following trace levels should be on:
      • 1-2 for the PI , SO and WB components.
      • 1-2 for the AP component if you have a codepage conversion problem.
      • 1-2 for the ML component if using CICS TS V4.1 or later. ML level 2 trace can affect performance.
      • 1-2 for the PG component if using CICS TS V3.2 or later. Alternatively, ALL for the PG component if using CICS TS V3.1.
      • 1 for all other CICS components
    • An unformatted CICS auxiliary trace if there is no dump available. See the trace levels documented under CICS internal trace above.
For CICS TS V3.1, the trace level for PG has to be set to ALL due to a bug in PG domain code. It should only need to be set to 1-2 to see the data being returned in containers but the trace point is invalidly issued at level 24 instead of level 2. ALL allows all the data to be seen.




Troubleshooting hints and tips


Diagnostic tips:
  • Review the logs and dumps generated at the point of failure.
  • Search the CICS support site for known problems using symptoms like the message number and error codes.
  • If you find a fixing PTF, see Ordering CICS products and maintenance for the options that are available to order CICS maintenance.
  • Gather the documentation and work with the CICS support team to resolve your problem.




Exchanging data with IBM Support

  1. See Exchanging information with IBM Technical Support for FTP and email instructions using the IBM Enhanced Customer Data Repository (ECuRep).
  2. Go to the Service Request page to open or update a problem. If you have a SoftwareXcel enterprise edition for zSeries contract, you can also ask a non-defect installation and usage questions.

    Note: Always update your Service Request (problem record) to indicate that data has been sent.

If you need to speak to an IBM technical support representative call your country representative. If you need to speak to an IBM technical support representative in the US, call 1-800-IBM-SERV.

[{"Product":{"code":"SSGMGV","label":"CICS Transaction Server"},"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Component":"Web Services","Platform":[{"code":"PF035","label":"z\/OS"}],"Version":"4.1;4.2;5.1;5.2;5.3;5.4","Edition":"","Line of Business":{"code":"LOB35","label":"Mainframe SW"}}]

Product Synonym

CICS/TS CICS TS CICS Transaction Server

Document Information

Modified date:
21 June 2018

UID

swg21220283