Personalize the table of contents and search results
genHistoryReport command
The genHistoryReport command generates
the historyReport.html report file in the current working
directory, which is usually the bin directory. The report
includes a list of changed components and installed or uninstalled maintenance
packages. The genHistoryReport script invokes the historyInfo script specifying
the correct parameters to place the information generated into an HTML file
in the current directory.
Product history information
The historyInfo tool
displays historical data about the product and the installation and removal
of maintenance packages for the product. This tool is particularly useful
when working with support personnel to determine the cause of any problem.
Product
history reports
The following report generation scripts extract
data from XML data files in the
properties/version folder
and the
properties/version/history folder:
- historyInfo
script
Lets you use parameters to create a history report.
- genHistoryReport script
Generates the historyReport.html report
file in the current working directory, which is usually the bin directory.
The report includes a list of components, fixes, fix packs, and refresh packs.
Location of the command file
The command file is a script.
The command file is named genHistoryReport in
the app_server_root/bin directory.
The command file is named genHistoryReport.sh in
the app_server_root/bin directory.
The command file is named genHistoryReport.bat in
the app_server_root\bin directory.
Syntax for the genHistoryReport command
Report description
The historyInfo command generates the report. The genHistoryReport command
calls the historyInfo command with a set of report parameters
that reports the following information:
Installation information
Installation information displays the following general information about
the current installation:
- Report date and time - The date and time that the report
was generated. The timestamp is formatted according to the current locale.
- Product directory - The file path to the installation root directory of
the product.
- Version directory - The file path of the version directory
of the current WAS installation.
- DTD directory - The file path of the DTD directory
of the current installation.
- Log directory - The file path of the log directory
of the current installation. The maintenance package log files are in the
directory.
- Backup directory - The file path of the backup directory
of the current WAS installation. The backup files generated during the installation
of maintenance packages are in this directory.
- TMP directory - The file path of the temporary directory of the current
machine.
- History directory - The file path of the history directory of the current
installation. The history files are in the directory.
- History File - The file path of the event.history file.
Installation event information
Installation event information displays the list of installed maintenance
packages (interim fix, fix pack, and refresh pack) and the following related
information:
- Maintenance package ID - The ID of the maintenance package.
- Action - The action taken with this maintenance package, which is either install or uninstall.
- Package file name - The file name of the maintenance package that was
installed.
- Log file name - The file path of the log file generated during the installation
or removal of the maintenance package.
- Backup file name - The file path of the backup file generated during the
installation of the maintenance package. This field does not apply for an
uninstall action.
- Timestamp - The time when the maintenance action (install or uninstall)
occurs. The time is stated in relation to GMT.
- Result - The result of the installation or removal action. The result
is either success, partial success, or failure.
Component installation event information
Component installation event information displays the following component-level
information of the event for the current maintenance package:
- Maintenance package ID - The ID of the maintenance package to which this
particular installation event belongs.
- Component name - The name of the current component.
- Action - The action taken on this component due to the action of the current
maintenance package, either install or uninstall
- Update action - The updated action taken on this component. By default,
the update action for an installation action is replace.
- Timestamp - The time at which the action occurs for the maintenance package
(GMT offset values).
- Result - The result of the install or uninstall action. The result is
either success, partial success or failure.
The event.history file
The
genHistoryReport command also generates the
event.history file.
This file represents the raw data of the history report information. The following
example of an
event.history file corresponds to the history
report in the preceding example:
<!DOCTYPE event-history SYSTEM "eventHistory.dtd">
<event-history>
<update-event
event-type="ptf"
id="was60_fp1_linux"
update-action="install"
primary-content="was60_fp1_linux.pak"
update-type="replace"
log-name=
"/opt/WebSphere/AppServer/logs/update/was60_fp1_linux.install/updatelog.txt"
backup-name=
"/opt/WebSphere/AppServer/properties/version/backup/was60_fp1_linux.pak"
start-time-stamp="2004-12-14 06:15:14-0500"
result="success">
<update-event
event-type="component"
parent-id="was60_fp1_linux"
id="activity"
update-action="install"
update-type="replace"
start-time-stamp="2004-12-14 06:15:14-0500"
result="success">
</update-event>
<update-event
event-type="component"
parent-id="was60_fp1_linux"
id=" activity.impl"
update-action="install"
update-type="replace"
start-time-stamp="2004-12-14 06:15:14-0500"
result="success">
</update-event>
</update-event>
<update-event
event-type="ptf"
id="was60_fp2"
update-action="install"
primary-content="was60_fp1_linux.pak"
update-type="replace"
log-name="/opt/WebSphere/AppServer/logs/update/was60_fp2.install/updatelog.txt"
backup-name="/opt/WebSphere/AppServer/properties/version/backup/was60_fp2.pak"
start-time-stamp="2004-12-14 10:25:34-0500"
result="partialSuccess">
<update-event
event-type="component"
parent-id="was60_fp2"
id="activity"
update-action="install"
update-type="replace"
start-time-stamp="2004-12-14 10:25:34-0500"
result="partialSuccess">
</update-event>
<update-event
event-type="component"
parent-id="was60_fp2"
id=" activity.impl"
update-action="install"
update-type="replace"
start-time-stamp="2004-12-14 10:25:34-0500"
result="partialSuccess">
</update-event>
</update-event>
<update-event
event-type="ptf"
id="was60_fp2"
update-action="uninstall"
primary-content=" was60_fp2.pak"
update-type="replace"
log-name=
"/opt/WebSphere/AppServer/logs/update/was60_fp2.uninstall/updatelog.txt"
backup-name="not applicable"
start-time-stamp="2004-12-18 17:29:12-0500"
result="partialSuccess">
<update-event
event-type="component"
parent-id="was60_fp2"
id="activity"
update-action="uninstall"
update-type="replace"
start-time-stamp="2004-12-18 17:29:12-0500"
result="partialSuccess">
</update-event>
<update-event
event-type="component"
parent-id="was60_fp2"
id=" activity.impl"
update-action="uninstall"
update-type="replace"
start-time-stamp="2004-12-18 17:29:12-0500"
result="partialSuccess">
</update-event>
</update-event>
<update-event
event-type="ptf"
id="was60_fp1_linux"
update-action="uninstall"
primary-content=" was60_fp1_linux.pak"
update-type="replace"
log-name=
"/opt/WebSphere/AppServer/logs/update/was60_fp1_linux.install/updatelog.txt"
backup-name="not applicable"
start-time-stamp="2004-12-23 15:15:14-0500"
result="faiurel">
<update-event
event-type="component"
parent-id="was60_fp1_linux"
id="activity"
update-action="uninstall"
update-type="replace"
start-time-stamp="2004-12-23 15:15:14-0500"
result="failure">
</update-event>
<update-event
event-type="component"
parent-id="was60_fp1_linux"
id=" activity.impl"
update-action="uninstall"
update-type="replace"
start-time-stamp="2004-12-23 15:15:14-0500"
result="failure">
</update-event>
</update-event>
</event-history>
Summary of Version 6 changes for the historyInfo command
Changes are in three areas: command syntax, report information, and the event.history file.
Changes to command syntax
Version 6 replaces the term updateID with maintenancePackageID to
describe a specific maintenance package. This matches the terminology used
in the Version 6 update installer application.
Changes to report information
The following changes are in effect:
- Version 6 replaces the term PTF ID with Maintenance
package ID. This change is consistent with the terminology used
in the Update Installer for WebSphere Software.
- Version 6 replaces the term Primary content with Package
file name.
- Version 6 replaces the terms Start Time and End
Time with a Timestamp for the completion of the
event.
- Version 6 removes the terms IsExternal, and IsCustom.
- Version 6 removes the Result Message section of the
report because the information is reported in the Result and Action section.
- Version 6 sets the value of Backup file name to "not
applicable" if the update action is uninstall. No backup
file is generated when a maintenance package is uninstalled.
- Version 6 adds a new result state, partial success. The Version 6 Update
Installer for WebSphere Software can generate a partial success.
Changes to the event.history file
The following changes are in effect:
- Version 6 replaces the terms Start Time and End
Time with a Timestamp for the completion of the
event.
- Version 6 removes the terms IsRequired, IsExternal, IsCustom, root-property-file, root-property-name, and root-property-value,
which are not supported by the Update Installer for WebSphere Software.
- Version 6 removes the Result Message section of the
report because the information is reported in the Result and Action section.
- Version 6 sets the value of update-event to "replace".
- Version 6 sets the value of Backup file name to "not
applicable" if the update action is uninstall. No backup
file is generated when a maintenance package is uninstalled.
- Version 6 adds a new result state, partial success. The Version 6 Update
Installer for WebSphere Software can generate a partial success.
|
