IBM FileNet Process Engine 5.0 ISA Data Collector

Answer

Data Collector for IBM FileNet Process Engine 5.0

The IBM FileNet Process Engine 5.0 Data Collector automates the collection of the basic information described in the Must Gather for FileNet Process Engine 5.0 document.

This data collector can be run on any platform on which the Process Engine 5.0 server software has been installed (Windows, Linux, AIX, Solaris, HP Integrity, or HP Risc).

This data collector makes it easy to gather the basic information about your Process Engine 5.0 server when you need to submit information for use with a PMR or defect report.

Note that IBM FileNet Process Engine 5.0 is the process engine component of the ICM (IBM Case Management) product. ICM 5.0 and ICM 5.1 users will use this data collector in the event of ICM issues involving the Process Engine.

This data collector uses the IBM Support Assistant ISA Lite Data Collector framework.

Note that running this data collector will not automatically enable any traces. Depending upon the problem being seen, it might be advisable to first enable some tracing and reproduce the problem and then run the data collector. Although, you can always create and gather traces later.

This data collector was built for the PE 5.0 release. It will not function on older or newer PE releases.

Using the ISA Lite Process Engine 5.0 Data Collector

Usually, you would do all of the data collection work while logged in as the user that did the PE install or the user that is used to run the PE software. If the user who is running the data collector does not have appropriate access to the things that need to be collected, the collector will not be able to collect everything that is needed.

The data collector must be run while logged on as a user who has enough privileges to

• see the PE's installation information (e.g., the ".com.zerog.registry.xml" file)
• run the PE utilities (e.g., vwtool)
• gather the required files (e.g., the PE logs and system logs)

To get the ISA Lite data collector:

1. Using a web browser on your PE Server or on another computer, you can go here: http://www-01.ibm.com/software/support/isa/ and click the large Data Collectors ... Learn more... button on the right of the screen.
2. In the Select a brand dropdown, select Enterprise Content Management.
3. In the Select a product dropdown, select FileNet Business Process Engine 5.x.
4. Click the Download ISA Lite for FileNet Business Process Engine 5.x link.
5. Provide your IBM ID user/password when prompted.
6. Select the I agree check box and click the I Confirm button.
7. Click the Download now link for the IBM Support Assistant Lite for IBM FileNet Process Engine 5.x (Windows, Unix and Linux) choice.
8. This will download a zip file called ISALite134ForFNPE5x-12132011.zip and this is the data collector itself.
9. If, in the previous step, you did not download the ISADC collector zip directly to the Process Engine server, you must now copy or move the ISADC data collector zip file to the Process Engine server. For example, for a Unix-based PE Server, you might use FTP to "put" the just-downloaded ISA Lite zip file to the /tmp directory on the PE Server.
10. Unzip the data collector zip file into the directory where you will run it. The unzip operation will create a folder called ISALite. The ISA Lite data collector can be run from any directory.
    
    Hint: on a Windows box, you could put the zip file in the c:\temp folder and unzip its contents there.
    
    Hint: on a Unix box, with the downloaded ISA Lite data collector zip file in the /tmp folder, in a command prompt, doing something similar to the following will unzip the data collector:
    cd /tmp
    unzip ISALite134ForFNPE5x-12132011.zip
11. In a command prompt window, cd into the ISALite folder that you just unzipped.
    For example, cd c:\temp\ISALite or cd /tmp/ISALite.
12. If your PE server is Unix-based (AIX, Linux, HP, or Solaris), in the directory where you unzipped data collector zip file (e.g., /tmp/ISALite), make the scripts executable by running this command:
    chmod +x *.sh
13. Set up JAVA_HOME environment variable if necessary.
    
    To run the isadc data collector, the environment variable JAVA_HOME should be set to the path of an installed java JRE. If the data collector can not find a java JRE, it will prompt for the path to a JRE.
    
    Because the Process Engine server software includes some java components, the Process Engine server may already have a usable JAVA_HOME already configured. For Process Engine Servers, you would usually use the java that is installed as the PE Server’s private JVM.
    
    Note: the ISALite infrastructure does not appear to like JREs with spaces in the path.
    
    On Windows, the following might be a good JAVA_HOME setting:
    set JAVA_HOME=<some path ending in\java\jre>
    
    On Linux or Unix, the following might be a good JAVA_HOME setting:
    JAVA_HOME=<some path ending in/java/jre>
    export JAVA_HOME
14. Run the data collector:
    On Windows: .\RunISALite.bat
    On Unix: ./RunISALite.sh

This will bring up a java GUI that is the data collector:

1	Expand the + by the "IBM FileNet P8" folder to expand the tree Select Gather Process Engine Information Enter a zip file name in the Filename for saving the collected data box. Optionally check the Show execution details to see more information about what is happening while the data collector is running. Click the Collect Data button.
2	Select a PE Virtual Server from the dropdown Click the OK button.
3	Enter a user name and password for a PE Administrator account - an account that can run vwtool. Click the OK button.
4	Select a region number from the dropdown Click the OK button. The data collector begins its work. If you have checked the Show execution details option, you will see information about what is being executed and collected. The amount of time the collector will take is dependent upon many things, but usually it takes between 5 and 10 minutes.
5	When the data collection has completed, you’ll be prompted with an opportunity to provide feedback on the data collection experience. Select one of the buttons. For example, Click the No button.
6	At this point, you're given an opportunity to upload the collected data directly to IBM. Select one of the choices for uploading the logs. For example, select Do not transfer the Logs to end the data collector and let you look at exactly what was collected and then you can upload later.
7	Click OK to dismiss this text box.
8	The collector is done. If you haven't done so already, put a check mark in the Show execution details and you will see at the bottom of the text, the exact location of the zip file that was generated.

Running the Data Collector Without a GUI

If, for some reason, you cannot you can not run the data collector in the java GUI, and you would like to run it in a command prompt window without any GUI at all, the only difference from the previous set of instructions is when you go to run the batch job, you include a -console option.

On Windows, you would enter .\runISALite.bat -console
On Unix, you would enter ./runISALite.sh -console

The same questions will be asked in the command prompt as are asked in the GUI. And the same data will be collected.

What is collected?

You can always look at the contents of the zip file after the data collector has completed in order to see exactly what information has been gathered.

Password information is never collected.

Here is a list of the information that is being gathered:

AIX Servers

Command	Collects
uname -a or oslevel -s	OS Version
/usr/sbin/instfix -ivq	OS Patches or Maintenance level
env	OS Environment Variables
errpt -a	OS Configuration & Error Reporting
/usr/sbin/lsattr -E -l sys0	OS Kernel parameters
ps -ef	currently running processes
netstat -an	socket information
no -a | grep udp_ephemeral	ephemeral port info
locale locale -a	locale information
/var/adm/syslog/syslog.log	include system log files
ls -RalF of the ProcessEngine directory	directory listing of Process Engine files

HP Servers

Command	Collects
uname -a	OS Version
/usr/sbin/swlist -l product	OS Patches or Maintenance level
env	OS Environment Variables
/usr/sbin/dmesg	OS Configuration & Error Reporting
/usr/sbin/sysdef	OS Kernel parameters
ps -ef	currently running processes
netstat -an	socket information
ndd /dev/udp udp_smallest_anon_port ndd /dev/udp udp_largest_anon_port	ephemeral port information
locale locale -a	locale information
/var/adm/syslog/syslog.log	include system log files
ls -RalF of the ProcessEngine directory	directory listing of Process Engine files

Solaris Servers

Command	Collects
uname -a	OS Version
/usr/bin/showrev -a	OS Patches or Maintenance level
env	OS Environment Variables
/usr/sbin/prtdiag -v	OS Configuration & Error Reporting
/usr/sbin/sysdef -D /usr/bin/getconf -a	OS Kernel parameters
ps -ef	currently running processes
netstat -an	socket information
/usr/sbin/ndd /dev/udp udp_smallest_anon_port /usr/sbin/ndd /dev/udp udp_largest_anon_port /usr/contrib/bin/nettune -l	ephemeral port information
locale locale -a	locale information
/var/adm/messages & /var/log/syslog	include system log files
ls -RalF of the ProcessEngine directory	directory listing of Process Engine files

Windows Servers

Command	Collects
systeminfo winmsd or msinfo32	OS Version, Patches and Maintenance level
tasklist	currently running processes
WMIC /OUTPUT:C:\ProcessList.txt PROCESS get Caption,Processid,Usermodetime,Commandline	current running processes including the command line
set	OS Environment Variables
Windows 2003: cscript C:\windows\system32\eventquery.vbs /L application /R 1000 /V cscript C:\windows\system32\eventquery.vbs /L system /R 1000 /V Windows 2008: wevtutil epl System Systemlog.evtx wevtutil epl Application Applicationlog.evtx	OS Event Logs
netstat -an	socket information
chcp	display code page
dir /s of the ProcessEngine directory	directory listing of Process Engine files
the following registry keys from SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\ MaxUserPort TcpMaxConnectTransmissions TcpMaxConnectRetransmissions	networking registry settings

Linux Servers

Command	Collects
uname -a	OS Version
/usr/bin/showrev -a	OS Patches or Maintenance level
env	OS Environment Variables
/usr/sbin/prtdiag -v	OS Configuration & Error Reporting
/usr/sbin/sysdef -D /usr/bin/getconf -a	OS Kernel parameters
cat /proc/sys/net/ipv4/ip_local_port_range	ephemeral port information
/usr/bin/getconf -a	configuration info
/bin/dmesg	messages
ps -ef	currently running processes
netstat -an	socket information
locale locale -a	locale information
/var/log/messages.*	include system log files
ls -RalF of the ProcessEngine directory	directory listing of Process Engine files

Information Gathered on all PE Server Platforms

The following information is gathered from the PE Server no matter what platform is being used. These commands are meant to show the basic information that is gathered. The exact commands used may include full specified paths to java and various jar files.

Inventory tagging information
vwserver.ini
PEInit Default -sc
java -classpath pesvr.jar filenet.jpe.general.JPEVersion
java -classpath pe.jar filenet.vw.toolkit.utils.VWBuildStamp

The output from the following vwtool commands is gathered, using the specified PE Virtual Server and specified region:

threaddump
configdetails
schemastatus
sysconfig b
appspace
dump f c s
config
queueconfig *
rosterconfig *
logconfig *
threaddump
dump s
regionConfig
dbviews
views
loadstatus
count *
threaddump

All logs and traces created within the last seven days, from these locations:

• .../ProcessEngine/data/logs/
• .../ProcessEngine/data/<pe server>/logs/

All javacores created within the last seven days from these locations:

• .../ProcessEngine/
• .../ProcessEngine/data/

The HTML pages returned from the following URLs (substituting appropriate server names, ports, region number, user id, and password):
http://ceserver:9080/wsi/FNCEWS40MTOM
http://ceserver:9080/FileNet/Engine
http://localhost:32776/IOR/ping?farm=true&user=xxx&pw=yyy
http://localhost:32776/IOR/ping?farm=true&acminfo=&user=xxx&pw=yyy
http://localhost:32776/IOR/FileNet.PE.vworbbroker