Preparing documentation for an authorized program analysis report (APAR)

http://www14.software.ibm.com/webapp/set2/sas/f/handbook/home.html

Having met these criteria, follow the instructions below.

1. Report the problem to IBM.

   If you have not already done so, report the problem to IBM by opening a problem management record (PMR).

   If you have IBMLink or some other connection to IBM databases, you can open a PMR yourself. Or, the IBM Software Support Center can open the PMR after consulting with you on the phone. The PMR is used to document your problem and to record the work that the Support Center does on the problem. Be prepared to supply the following information:

   • Customer number
   • PMR number
   • Operating system
   • Operating system release level
   • Your current Language Environment maintenance level (PTF list and list of APAR fixes applied)
   • Keyword strings you used to search the IBM software support database
   • Processor number (model and serial)
   • A description of how reproducible the error is. Can it be reproduced each time? Can it be reproduced only sometimes? Have you been unable to reproduce it? Supply source files, test cases, macros, subroutines, and input files required to re-create the problem. Test cases are not required, but can often speed the response time for your problem.

   If the IBM Support Center concludes that the problem described in the PMR is a problem with the Language Environment product, they will work with you to open an APAR, so the problem can be fixed.

2. Provide APAR documentation. When you submit an APAR, you will need to supply information that describes the failure. Table 1 describes how to produce documentation required for submission with the APAR.

   Table 1. Problem resolution documentation requirements

   Item	Materials Required	How to Obtain Materials
   1	Machine-readable source program, including macros, subroutines, input files, and any other data that might help to reproduce the problem.	IBM-supplied system utility program
   2	Compiler listings: Source listing Object listing Storage map Traceback Cross-reference listing JCL listing and linkage editor listing Assembler-language expansion	Use appropriate compiler options
   3	Dumps Language Environment dump System dump	See instructions in Using Language Environment debugging facilities (as directed by IBM support personnel).
   4	Partition/region size/virtual storage size
   5	List of applied PTFs	System programmer
   6	Operating instructions or console log	Application programmer
   7	JCL statements used to invoke and run the routine, including all runtime options, in machine-readable form	Application programmer
   8	System output associated with the MSGFILE runtime option.	Specify MSGFILE(SYSOUT)
   9	Contents of the applicable catalog
   10	A hardcopy log of the events leading up to the failure.	Print out each display.

3. Submit the APAR documentation.

   When submitting material for an APAR to IBM, carefully pack and clearly identify any media containing source programs, job stream data, interactive environment information, data sets, or libraries.

   All magnetic media submitted must have the following information attached and visible:

   • The APAR number assigned by IBM.
   • A list of data sets on the tape (such as source program, JCL, data).
   • A description of how the tape was made, including:
     • The exact JCL listing or the list of commands used to produce the machine-readable source. Include the block size, LRECL, and format of each file. If the file was unloaded from a partitioned data set, include the block size, LRECL, and number of directory blocks in the original data set.
     • Labeling information used for the volume and its data sets.
     • The recording mode and density.
     • The name of the utility program that created each data set.
     • The record format and block size used for each data set.

   Any printed materials must show the corresponding APAR number.

   The IBM service personnel will inform you of the mailing address of the service center nearest you.

   If an electronic link with IBM Service is available, use this link to send diagnostic information to IBM Service.

After the APAR is opened and the fix is produced, the description of the problem and the fix will be in the software support database in SIS, accessible through ServiceLink.