9 Error Diagnosis and Reporting

This chapter discusses error diagnosis and reporting for Oracle Access Manager for AS/400. It includes the following sections:

Trace Files from the Access Manager

Trace files are emitted by the Access Manager according to parameters set on the CHGSQLDBG screen. To cause a trace file to be written, place a 1 on the line titled "Access Manager debugging control string." Members will be placed in the Access Manager trace file which is designated by the next two lines on the CHGSQLDBG screen. If you need to create a new trace file, then use the following command as a template:

CRTPF mylib/mytracefile RCDLEN(240) MAXMBRS(*NOMAX)

where mylib is any library and mytracefile is any file name you choose. Update the CHGSQLDBG panel when changing the name and/or library where the trace files are to be written. You should give enough authority to users of the Access Manager so that this file can be written.

Members written to the trace file will be named similarly to MBRnnnnnn where nnnnnn will start at 000001 for each Access Manager session. One can avoid the resetting of the Trace File member sequence numbers by using the following:

  1. Turn on tracing through the CHGSQLDBG command.

  2. Start an Access Manager session.

  3. Check the QTEMP library for a User Space named ARDTRCSER.

  4. Move this object to the Access Manager library.

  5. Ensure that you give enough authority to Access Manager users so they can read and write this User Space.

Trace Files for Oracle Net

If so specified on the CHGSQLNET command, then Oracle Net trace files will be written to a file named instance/TRC where "instance" is the library of the Access Manager install. Members in this file will have names similar to CLNTnnnnnn, where the nnnnnn is the job number of the Access Manager job.

Contacting Oracle Support Services

To maximize the effectiveness of your queries, gather the following information before contacting Oracle Support Services:

  • OS/400 release number

  • Exact Access Manager release number (found in the JobLog)

  • Exact Oracle Net release number (found in the JobLog)

  • Oracle Database Server release number and platform

  • You may be asked to supply a JobLog and trace files for problem diagnosis. See How to Provide Items for Problem Diagnosis for information about how to provide these items.

Error categories

Use the following error categories to describe the error:

Documentation Error

When reporting documentation errors, you will be asked to provide the

  • document name

  • document part number

  • document publication date

  • page number

Describe the error in detail. Documentation errors can include erroneous documentation and omission of required information.

Incorrect Output

In general, an incorrect output error occurs whenever an Oracle supplied program (such as the Access Manager) produces a result that differs from what would be expected. When describing errors of this type, you need to describe, in detail, exactly what you expect the output to be; any non-obvious reason why you expect different output should be explained in detail.

If you think that you have found a software bug, then be prepared to answer the following questions:

  • What are the exact SQL statements that cause the problem, if it is a data error.

  • What is the full OS/400 Version in which the error occurs; what is the version of the Access Manager, CORE, and Oracle Net (the Oracle information should appear in the JobLog)

  • What exactly is the problem and how is it reproduced

Try to pare down the number of steps or the program that causes the error; the simpler the number of steps that Oracle support needs to re-create the problem, the better; the simpler the user program that causes the error, the better.

Oracle External Error

Most Oracle errors (and some warnings) are placed in the JobLog.

Performance

AS/400 system performance is determined by many factors, most of which are not in the control of Oracle. Considerations such as system load, I/O topology, network topology, and DB2/400 resource availability make documentation of performance errors difficult.

Provide detailed information about the state of your environment when reporting a performance problem. Specific documentation might include:

  • CPU type and memory configuration

  • network topology

  • Oracle workload characteristics

  • query execution plans

Missing Functionality

Enhancement requests can be opened with Oracle Support Services to request the inclusion of functions and features that are not currently available with Oracle products such as the Access Manager. When opening an enhancement request, describe the specific feature or function to be added to the Access Manager, and provide a business case to justify the enhancement.

How to Provide Items for Problem Diagnosis

Here are some of the items that should be provided for problem diagnosis:

  • A JobLog that may show the error. Even if it does not show the error explicitly, Support Services may be able to use the JobLog for problem determination and resolution. The Job Log should be provided as a member of a physical file that has a maximum record length of 133. Use the CPYSPLF command to copy a spooled JobLog to a physical file. Use a member name of JBLGkkkkk where kkkkkk us the Job Number.

  • An Access Manager trace file. This should be provided as an actual physical file. If you want to provide the actual physical file used by the Access Manager, then specify which member contains the trace to be perused.

  • An Oracle Net trace file. This should be provided as an actual physical file. If you want to provide the actual physical file, please tell us the job number of the job that had the problem.

  • If the error occurs in STRSQL, then use PF13 and then option 2 to print a spooled copy of the session log. Use CPYSPLF to copy this spooled file to the same physical file to which the JobLog was copied. You should use a member named of STRSQLmmmm.

  • If the error occurred in a user program, try to pare down the program to a point where the error still occurs. If possible, try to pare the program down to a point where "include" files are not needed. Provide a physical source file containing the source of the program; include the "include" files if they are needed to compile the program.

  • Any other files that you feel would help Support Services diagnose the problem are appreciated. Add a note as to why these additional files are relevant.

  • Include a README file which exactly specifies the problem. Tell us if the problem was not apparent on previous releases of the Access Manager. Tell us if the problem was not apparent when using previous versions of Oracle. We need to know the version numbers (all five fields as in 10.2.0.1.0). Tell us if the configuration of your AS/400 has recently changed. This includes changing the system name, and reconfiguration of TCP/IP addresses.

Note:

The "timestamps" on the files provided, especially for the JobLogs and Trace FIles, should be consistent. They should all be produced at about the same time. Including a JobLog from a Sunday run and trace files from a Tuesday run is not a good idea. If you submit files with inconsistent time stamps, then you will most likely be asked to gather the information again.

Package up all the files into a Save File. Support services will tell you where to FTP such a Save File. Remember to FTP the Save File in binary mode. Submission of files in PDF or MicroSoft Word format is strongly discouraged.