IBM Support

Data Collector Usage for IBM FileNet Content Manager 5.2

Question & Answer


Question

How do I set up and use the ISA Data Collector to gather information for the Content Engine, Process Engine, and Rendition Engine components of the IBM FileNet Content Manager 5.2?

Answer

Data Collector for the Content Engine, Process Engine, and Rendition Engine components of IBM FileNet Content Manager 5.2


The IBM FileNet Content Manager 5.2 Data Collector automates the problem-reporting data collection tasks for the Content Engine, Process Engine, and Rendition Engine components of the Content Manager 5.2 and Content Platform Engine 5.2 products.

This data collector automates the collection of the information described in these Must Gather documents:
MustGather: Read first for FileNet Content Engine
MustGather: Read first For IBM FileNet Content Manager 5.2 - Process Engine Component

This data collector can be run on any platform on which the Content Manager 5.2 or Content Platform Engine 5.2 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 IBM FileNet Content Manager 5.2 server when you need to submit information for use with a PMR or defect report.

ICM 5.2 users will use this data collector in the event of ICM issues involving the Content Engine, Process Engine, or Rendition Engine.

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. But, you can always create and gather traces later.

The general information about the IBM Support assistant Data Collector (ISADC) can be found on this IBM Support Assistant Data Collector Technote.

ISADC is an applet running in the browser. This data collector gathers the log, trace and configuration files from the machine directly. The ISA Data Collector must be run on the server on which the needed diagnostic data is located. For this data collector, you will run the data collector on the server where the IBM FileNet Content Manager 5.2 software is installed and running.

Three Ways To Run The Data Collector
Running The Data Collector While Connected To The Internet
Collect for Process Engine Runtime Problem
Collect for Content Platform Engine Runtime Problem
Collect for Search Services Problem
Collect for Install/Configuration Problem
Collect for Search Engine Problem
Collect for Rendition Engine Runtime Problem
Download Zip And Run Collector Locally
What is Collected?






Using the IBM FileNet Content Manager 5.2 Data Collector


There are three ways to run the data collector:
  1. Using a web browser on your IBM FileNet Content Manager 5.2 server, you can go to the IBM Support Assistant Data Collector web site and select and run the FileNet Content Platform Engine 5.2 data collector directly from within your web browser.
  2. You can go to the IBM Support Assistant Data Collector web site and download a data collector zip file that you can then unzip on the IBM FileNet Content Manager 5.2 server. The unzipped isadc folder contains an index.html file that lets you run the data collector from within a web browser using the contents of the unzipped isadc folder.
  3. You can go to the IBM Support Assistant Data Collector web site and download a data collector zip file that you can then unzip on the IBM FileNet Content Manager 5.2 server. The unzipped isadc folder contains a script (isadc.bat for Windows and isadc.sh for Unix/Linux) that lets you run the data collector in a command prompt window.

When running the IBM FileNet Content Manager 5.2 data collector, you should be logged on to the IBM FileNet Content Manager 5.2 server under the user that installed the IBM FileNet Content Manager 5.2 software or the user that is running the IBM FileNet Content Manager 5.2 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 successfully collect everything that is required.

For example, when collecting the Process Engine data, the data collector must be run while logged on as a user who has enough privileges to
  • see the IBM FileNet Content Manager 5.2 installation information (e.g., the ".com.zerog.registry.xml" file)
  • gather the required files (e.g., the PE logs and system logs)



Running the Data Collector in a Web Browser on an IBM FileNet Content Manager 5.2 Server Connected to the Internet

1
  1. In a web browser on the IBM FileNet Content Manager 5.2 server, go to
    http://public.dhe.ibm.com/software/isa/isadc/2.0/isacoreweb/2.0.1/isadc
  2. Select FileNet Content Platform Engine 5.2 in the "I need to collect data for" dropdown.
  3. Select the "this system using the current browser" radio button under "I want to collect from:"
  4. Read and accept the license agreement.
  5. Click Start Collection

2If you do not have a suitable java plugin installed for your web browser, follow the prompts to get a java plugin installed.


Note: If you cannot get a suitable java plugin for your web browser, or don't want to install a java plugin for your web browser, you can run the data collector without a browser, as described here.
3The ISA Data Collector GUI initiates in the web browser:

4Click the + to view the data collector scripts located within the IBM FileNet Content Manager 5.2 folder


At this point, you are ready to run any of the data collector scripts that are listed. Each script will ask different questions and collect different data. Details of each data collector script are discussed below.

Once the data has been collected by a particular script, the data collector will complete with the following two questions:

1When the data collection has completed, you’ll be prompted with an opportunity to provide feedback on the data collection experience. Select one of the options:

2Then, you are given a chance to FTP the gathered data directly to IBM. Select one of the options:



If you want, you can select Do Not Transfer and look at exactly what has been collected and manually upload the data later.
3The collector is done. If you selected Do Not Transfer in the previous step, the actual name and location of the zip file containing the collected data will appear on the data collector screen:







To run the IBM Content Manager 5.2 Process Engine Runtime Problem script

1
  1. Select IBM Content Manager 5.2 Process Engine Runtime Problem
  2. Click Start

2You will be prompted for a user name and password that will be used while running the various tools while gathering information.
  1. Enter a user name and password with Process Engine Administrator privileges
  2. click OK
3If you have more than one Connection Point defined, you will be prompted to select a connection point from a dropdown list. If you have only one connection point defined, you will not be prompted.
  1. Select the connection point that is being used when the problem occurs
  2. Click OK

4At this point, the data collector will start gathering data.
Although the actual time to do the collection varies, this collector typically takes between two and ten minutes to gather the data with this script.






To run the IBM Content Manager 5.2 Content Platform Engine Runtime Problem script

1
  1. Select IBM Content Manager 5.2 Content Platform Engine Runtime Problem
  2. Click Start

2
Select the Application server type and enter the Application server installation directory
On Windows for WebSphere the installation root directory is C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\AppSrv01

3
Information for the FileNet Content Engine status page

4
Select the directory for the FileNet Content Engine trace and error logs directory

The location for the trace logs in the Content Engine can be changed using the FileNet Enterprise Manager. Please make sure you have entered the right values.


On Windows WebSphere deployment CE logs are at C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\AppSrv01\FileNet\server1







To run the IBM Content Manager 5.2 Content Search Services Problem script

1
  1. Select IBM Content Manager 5.2 Content Search Services Problem
  2. Click Start
2
Select the FileNet Content Search Services server installation root directory.

Start this task only after shutting down the CSS server.


Default installation directory
Windows C:\Program Files\IBM\Content Search Services\CSS Server






To run the IBM Content Manager 5.2 Content Platform Engine install/Configuration Problem script

1
  1. Select IBM Content Manager 5.2 Content Platform Engine install/Configuration Problem
  2. Click Start


2
Select FileNet Content Engine installation root directory.

This collector looks for the logs directory under <ContentEngine_Install_directory>\tools\configure\logs and will fail if it that directory does not exist.



Default FileNet Content Engine installation directory on Windows C:\Program Files (x86)\IBM\FileNet\ContentEngine


3
Select FileNet Content Engine installation root directory.

This collector looks for the <ContentEngine_Install_directory>\tools\upgrade and will fail if it that directory does not exist.



4
Select the Application server type and enter the Application server installation directory

5
Information for the FileNet Content Engine status page

6
Select the directory for the FileNet Content Engine trace and error logs directory

The location for the trace logs in the Content Engine can be changed using the FileNet Enterprise Manager. Please make sure you have entered the right values.



On Windows WebSphere deployment CE logs are at C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\AppSrv01\FileNet\server1





To run the IBM Content Manager 5.2 Content Search Engine Problem script

1
  1. Click IBM Content Manager 5.2 Content Search Engine Problem
  2. Click Start


2
Select FileNet content search Engine installation root directory

Default directory on Windows C:\Program Files\FileNet\ContentEngine\verity









To run the IBM Content Manager 5.2 Rendition Engine Runtime Problem script


1
  1. Click IBM Content Manager 5.2 Rendition Engine Runtime Problem
  2. Click Start

2
Select the Application server type and enter the Application server installation directory
On Windows for WebSphere C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\AppSrv01

3
Information for the FileNet Content Engine status page

4
Select the directory for the FileNet Content Engine trace and error logs directory

The location for the trace logs in the Content Engine can be changed using the FileNet Enterprise Manager. Please make sure you have entered the right values.



On Windows WebSphere deployment CE logs are at C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\AppSrv01\FileNet\server1







Running the Data Collector Without a GUI or While Not Connected to the Internet
If, for some reason, you cannot you can not directly run the ISADC collector in a web browser on the IBM FileNet Content Manager 5.2 server while connected to the internet, there are provisions for downloading a zip file, unzipping it, and running the downloaded data collector using a script/batch file in a command prompt window or using an html file in your web browser.

1Download the Data Collector
  1. In a web browser on some computer, go to http://public.dhe.ibm.com/software/isa/isadc/2.0/isacoreweb/2.0.1/isadc
  2. Select FileNet Content Platform Engine 5.2 in the "I need to collect data for" dropdown.
  3. Select the "this or another system using a downloadable utility" radio button.
  4. Read and accept the license agreement.
  5. Click either Download Windows or Download Unix/Linux, depending upon which operating system the server hosting the IBM FileNet Content Platform Engine 5.2 software is running.

2Copy the Data Collector zip file to the IBM FileNet Content Platform Engine 5.2 server

If, in the previous step, you did not download the ISADC collector zip directly to the IBM FileNet Content Platform Engine 5.2 server, you must now copy the ISADC data collector zip file to the IBM FileNet Content Platform Engine 5.2 server. For example, for a Unix-based IBM FileNet Content Platform Engine 5.2 server, you might use FTP to "put" the just-downloaded ISADC zip file to the /tmp directory on the server.
3Unzip the data collector

Unzip the data collector zip file (or .tar.gz file) into the directory where you will run it. The unzip operation will create a folder called isadc. The ISADC data collector can be run from any directory.

Hint: on a Unix box, with the downloaded isadc 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
tar -xzvf P8PE5.0_P8PE5.1.tar.gz
4In a command prompt window, cd into the isadc folder that you just unzipped.

For example, cd \isadc or cd /tmp/isadc.
5Make Unix/Linux script executable

If your IBM FileNet Content Platform Engine 5.2 server is Unix-based (AIX, Linux, HP, or Solaris), in the directory where you unzipped data collector zip file (e.g., /tmp/isadc), make the scripts executable by running this command:
chmod +x *.sh
6Set 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 JVM, it will prompt for the path to a JVM.

On Windows, the following might be a good JAVA_HOME setting:
set JAVA_HOME=c:\Program Files (x86)\IBM\FileNet\ContentEngine\_cejvm\java\jre

On Linux or Unix, the following might be a good JAVA_HOME setting:
JAVA_HOME=/opt/ContentEngine/_cejvm/java/jre
export JAVA_HOME
7Start the data collector either in the command prompt window or in a web browser.

If you want to run the data collector in a command prompt window without a GUI
    Start the data collector using the appropriate command in the command prompt window:
    Windows: .\isadc.bat
    Unix or Linux: ./isadc.sh

    You will be asked to accept a software license agreement.

    Then, the same questions will be asked in the non-GUI command prompt data collector as are asked when the data collector is running in the web browser (as described in the "Running the Data Collector in a Web Browser on an IBM FileNet Content Manager 5.2 Server Connected to the Internet" section).

If you want to run the data collector in a web browser directly from the downloaded and unzipped isadc folder
    Bring up a web browser on the IBM FileNet Content Platform Engine 5.2 server and go to the index.html file that is in the isadc folder you just unzipped. For example, on a Windows-based PE Server, you might go to c:\isadc\index.html.
    The web browser will then start the data collector and the questions and responses should be similar to what is described in the "Running the Data Collector in a Web Browser on an IBM FileNet Content Manager 5.2 Server Connected to the Internet" section.






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.

Refer to the two Must Gather documents for the details of what is collected:
MustGather: Read first for FileNet Content Engine
MustGather: Read first For IBM FileNet Content Manager 5.2 - Process Engine Component
[{"Product":{"code":"SSTHRT","label":"IBM Case Foundation"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Not Applicable","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"},{"code":"PF016","label":"Linux"}],"Version":"5.2","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

More support for:
IBM Case Foundation

Software version:
5.2

Operating system(s):
AIX, HP-UX, Solaris, Windows, Linux

Document number:
221249

Modified date:
17 June 2018

UID

swg21627110

Manage My Notification Subscriptions