IBM WebSphere Payment Manager Problem Determination Tool WPM_PDtool - Version 1.7 One of the challenges associated with problem determination is the gathering of all of the necessary and appropriate information that might be of assistance to the process of identifying what, exactly, is occurring. The purpose of this tool is to simplify this information gathering process, so that as much pertinent information as possible, is obtained all at one time. SOFTWARE REQUIREMENTS: A system on which IBM WebSphere Payment Manager has been installed. Optional: Perl (version 5.4 or above) DISK SPACE REQUIREMENTS: The Perl scripts, and this readme require very little space. The only actual disk space requirements are when the program is executing, and copying and/or creating files in the TEMP directory. You will need approximately 10MB of disk space available on the disk on which your TEMP directory is located, in order to save the gathered information. More space may be required, if a large log file size has been configured, and if many large files have been created. DISCLAIMERS: Please read, and accept the License agreement associated with this toolkit. This agreement can be found in the "WPM_PDtool License.txt" file. If you do not agree with any restrictions found therein, please delete all files associated with this toolkit. PRE-INSTALLATION INSTRUCTIONS: This toolkit is a collection of Perl script files. It currently supports Windows platforms (i.e., Windows/NT, and Windows/2000). You may choose to either use the freestanding executable (WPM_PDtool.exe) which is included in this package, or you may choose to use a Perl interpreter which you have installed, or may install on your system. Why would you would probably prefer to use the Perl interpreter, instead of the frestanding executable? Two possible reasons include: - If you want to modify the Perl scripts, or - If you already have the Perl interpreter installed on your system. Perl is an open source programming language available for almost every platform imaginable. Since it is open source, you can obtain the complete source code for the interpreter. You can also choose to download a binary executable for your platform in order to simplify the installation. To obtain an interpreter for your system, point your web browser to the following URL, and download the appropriate version. http://www.perl.com On machines using Windows NT, if you choose to download the binary version of the Perl interpreter, you may also have to download a small installation program which is used to simplify the installation and configuration of the interpreter. To make this determination, do the following: 1. Start -> Programs -> Windows NT Explorer 2. View -> Options ... 3. Select "File Types" tab 4. Look for "Windows Installer Package". It should be associated with the .MSI extension, and should be opened by MSIEXEC. If this is present, you should not need to execute the installation program. If it is not present, or is not associated with the proper executable, then you should download and execute the installation program. SPECIAL NOTE: As is the case with any executable that you download, you should first, before executing it, scan it for the presence of any known computer viruses. INSTALLATION PROCEDURE: The files included in this package (WPM_PDtool.zip) are identified below. Use an archive utility such as PKzip (http://www.pkware.com), or WinZip (http://www.winzip.com), to extract these files to a directory that is specified in your PATH environment variable (e.g., the directory into which the IBM WebSphere Payment Manager was installed). - WPM_PDtool Readme.txt = This readme file - WPM_PDtool License.txt = License Agreement - WPM_PDtool.exe = Freestanding executable - WPM_PDtool.pl = Primary perl script file - WinRegDump.pl = Perl routine to display Windows Registry COMPLETING INITIAL CONFIGURATION Verify that the fmttrace executable is available. On Windows systems it should be PaymentManager\lib\fmttrace.exe EXECUTION INSTRUCTIONS: 1. Open a command prompt 2. Change to the Payment Manager installation directory e.g., C:\> cd C:\Program Files\IBM\PaymentManager 3. Invoke the freestanding executable, and specify the name of the directory containing the Payment Manager log files. For example: C:\Program Files\IBM\PaymentManager> WPM_PDtool log 4. Follow the directions in the "AFTER EXECUTION" section below. INFORMATION GATHERED On Windows - System hardware details (e.g., # of processors, memory, etc.) - Network configuration information (output of ipconfig command) - Contents of \HKEY_LOCAL_MACHINE\Software\IBM registry subtree - Payment Manager install.trace files - WebSphere Payment Manager xml & configuration files (WASPM*) - netstat output - FormatTrace output - FormatServletTrace output - Formatted dump/trace files (using the fmttrace command) Yet to be done: - WebSphere log file(s) (e.g., webspherepaymentmanager.log) - web server config file (httpd.conf) - support the other platforms on which WebSphere Payment Manager is supported SAMPLE EXECUTION Note: By default, the Payment Manager program is installed into the C:\Program Files\IBM\PaymentManager directory. In addition, log files are, by default written to the log subdirectory contained therein. So, if you have the installation directory as your current working directory, then the directory into which the log files are written can be specified using relative directory addressing, as shown in the following example invocation: C:\Program Files\IBM\PaymentManager>WPM_PDtool log WPM_PDtool 1.7 #--------------------------------------------------------------------- # Creating the following directory, to hold the data. # C:\Documents and Settings\pmadmin\Local Settings\Temp\WPM_PDtool #--------------------------------------------------------------------- copying install.trace files copying any WASPM* files that are present #--------------------------------------------------------------------- # Warning: The following command may take a few minutes to complete. #--------------------------------------------------------------------- msinfo32 >sysinfo.txt ipconfig /all >ipconfig.out netstat -a >netstat_a.out netstat -an >netstat_an.out RegDump \HKEY_LOCAL_MACHINE\Software\IBM >ibmsw.out copying eTillError & PSError files copying *.properties files Formatting file: C:\Program Files\IBM\PaymentManager\log\eTillTrace1.log 24 records processed... *** Done formatting files... Elapsed time = 661 ms. Formatting file: C:\Program Files\IBM\PaymentManager\log\PSTrace1.log 30 records processed... *** Done formatting files... Elapsed time = 701 ms. C:\Program Files\IBM\PaymentManager>dir %TEMP%\WPM_PDtool Directory of C:\DOCUME~1\pmadmin\LOCALS~1\Temp\WPM_PDtool 09/14/01 01:03p . 09/14/01 01:03p .. 09/13/01 10:35a 69,729 cc22_install.trace.2001.9.13_0 09/14/01 01:03p 5,748 Dump.1.2001-09-13.10-36-09 09/13/01 01:05p 1,678 eTillError 09/14/01 01:03p 1,181 eTilltails.out 09/14/01 01:03p 3,168 FormatServletTrace.out 09/14/01 01:03p 3,016 FormatTrace.out 09/14/01 01:03p 18,435 ibmsw.out 09/14/01 01:03p 843 ipconfig.out 09/14/01 01:03p 10,112 netstat_a.out 09/14/01 01:03p 10,055 netstat_an.out 09/13/01 10:29a 290,424 ps22_install.trace.2001.9.13_0 09/13/01 01:17p 880 PSError 09/13/01 10:34a 132,796 set22_install.trace.2001.9.13_0 09/14/01 01:03p 225,718 sysinfo.txt 09/13/01 10:35a 1,317 WASPMCyber.xml 09/13/01 10:35a 1,732 WASPMCyberExport.trace 09/13/01 10:35a 10,917 WASPMCyberExport.xml 09/13/01 10:35a 322 WASPMCyberImport.xml 09/13/01 10:35a 484 WASPMCyberXMLConfig.trace 09/13/01 10:28a 6,480 WASPMFramework.xml 09/13/01 10:28a 4,273 WASPMFrameXMLConfig.trace 09/13/01 10:33a 2,848 WASPMSET.xml 09/13/01 10:33a 1,470 WASPMSETExport.trace 09/13/01 10:33a 9,518 WASPMSETExport.xml 09/13/01 10:32a 322 WASPMSETImport.xml 09/13/01 10:33a 1,972 WASPMSETXMLConfig.trace 09/14/01 01:03p 1,071 WPM_Format.cmd 27 File(s) 816,509 bytes 2 Dir(s) 11,018,784,768 bytes free AFTER EXECUTION The script, as it identifies when it executes, creates a temporary directory, into which it copies data. To provide this information to the IBM WebSphere Payment Manager service group, please do the following: 1. Use an archive utility utility of your choosing (e.g., PKZip, or WinZip) to collect, and compress the gathered files (the entire contents of the directory created by the utility). 2. Use an ftp client to sent these file to IBM, so they can be viewed and analyzed by support and development personnel. The name of the ftp site to which you should send your files is: testcase.software.ibm.com To log into that site, you should use the anonymous userid. When prompted for a password, please enter your correct e-mail address. Once you log in, files being sent to IBM support should be placed in a directory named for the associated Problem Management Record (PMR). This directory should be created in the paymentsuite/toibm directory. For the example below, we will use a PMR number of 12345, from branch office 678 and with a country code of 987. Thus the example below creates a directory named "12345.b678.c987". Files to be sent to IBM should be transferred in binary. To do this, issue the 'bin' command. To send an individual file, you can use the "put" command. In the example below, the name of the file to be sent is "filename.zip" Example ftp session: ---------------------------------------------------------------------- C:\TEMP\WPM_PDtool> ftp testcase.software.ibm.com 220-********************************************************************* 220-* IBM * 220-* * 220-* - IBM Support Centers Data Exchange (using "anonymous") * 220-* Please work with your IBM representative before placing or * 220-* downloading files. Downloadable files are intended to * 220-* resolve a specific problem and may introduce problems with * 220-* unauthorized installations. * 220-* See /README_PS.TXT for information from the Personal * 220-* Software support group. * 220-* * 220-* - Registered Downloads of software (using IBM provided userid) * 220-* * 220-* * 220-********************************************************************* 220- User (hostname.companyname.com:(none)): anonymous 331 Guest login ok, send your complete e-mail address as password. Password: < Please enter your correct e-mail address > 230-Please read the file README_PS.TXT 230 Guest login ok, access restrictions apply. ftp> cd paymentsuite/toibm 250 CWD command successful. ftp> mkdir 12345.b678.c987 < Please create a directory with your PMR# > 257 "/paymentsuite/toibm/12345.b678.c987" new directory created. ftp> cd 12345.b678.c987 < Don't forget to change to this directory > 250 CWD command successful. ftp> pwd 257 "/paymentsuite/toibm/12345.b678.c987" is current directory. ftp> bin 200 Type set to I. ftp> put filename.zip 200 PORT command successful. 150 Opening BINARY mode data connection for .... 226 Transfer complete. ftp: ... bytes sent in .... Seconds ... Kbytes/sec. ftp> quit ---------------------------------------------------------------------- OPTINAL INSTALLATION INSTRUCTIONS (Windows): The following steps are optional. If you are only going to be using the freestanding executable, then they are unnecesary. If, on the other hand, you install the Perl interpreter, and would like to have Windows (either NT, or 2000) recognize all files which have an extension of .pl as being Perl scripts, and automatically invoke the Perl interpreter, you may want to do the following: 1. Use the assoc command to associate the .pl extension with Perl: assoc .pl=PerlScript 2. Use the ftype command to associate PerlScript files with the Perl interpreter (using the actual path to your perl executable): ftype PerlScript=c:\perl\bin\perl.exe "%1" %* 3. Add .pl to the list of extensions recognized as executable, by adding it to the PATHEXT environment variable. Start -> Settings -> Control Panel Double-click on System On Windows 2000: a. Select the Advanced tab b. Click the Environment Variables button c. In the System Variables section, scroll down, and select PATHEXT variable d. Click the Edit button e. Append (or prefix) the .pl extension to the list, using ; to separate it from the ones that precede (or follow). f. Click OK, to close the Edit System Variable window g. Click OK, to close the Environment Variables window h. Click OK, to close the System Properties window On Windows NT: a. Select the Environment tab b. In the System Variable section, select the PATHEXT variable c. Append (or prefix) the .pl extension to the list, using ; to separate it from the ones that precede (or follow). d. Click the SET button to accept the modification e. Click OK to close the System Properties window 4. Now, to execute Perl scripts, all you need do, is to type the Perl script name (i.e., WPM_PDtool). You no longer have to either add the extension (.pl), or specify the perl command. Note: If you have .pl as the first extension in the PATHEXT environment variable, then Windows will look first for files with this extension when it is trying to execute commands. Therefore, if you have ProgramName.pl and ProgramName.exe files in the current working directory, when you type ProgramName at the command prompt, the Perl interpreter will be the one that actually gets executed.