Product version information

 

+

Search Tips   |   Advanced Search

 

The WAS product contains structural differences from previous versions.

The directory...

app_server_root/properties/version

...contains important data about the product and its installed components, such as the build version and build date. This information is included in files...

• WAS.product
• [component].component

Run the historyInfo command to create a report about installed maintenance packages. The historyInfo command creates a report on the console and also creates tracking files in...

app_server_root/properties/version/history

Time-stamped, detailed logs record each update process in...

app_server_root/ properties/version/log

This topic describes the XML data files that store product information for V6 WAS products. By default, the document type declarations (DTDs) for these files are in the folder...

app_server_root/properties/version/dtd

This topic includes the following sections:

• Product information files
• Reports
• Logs and component backups
• Directory locations
• Operational description
• Data dictionary

 

Product information files

XML files in the properties/version directory that store version information:

platform.websphere

One file whose existence indicates that a WAS product is installed. An example of the file follows:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE websphere PUBLIC "websphereId" "websphere.dtd">
<websphere name="IBM WAS" version="6.1"/>

The following XML files in the properties/version directory represent installed items and installation events such as product edition, version, component, and build information.

WAS.product

One file whose existence indicates the particular WAS product that is installed. The type of product installed is indicated by the <id> tag. Data in the file indicates the version, build date, and build level. For example, <id>ND</id>.product indicates that the installed product is WAS ND. An example of the file follows:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE product PUBLIC "productId" "product.dtd">
<product name="IBM WAS - ND">
  <id>ND</id>
  <version>6.1.0</version>
  <build-info date="02/03/06" level="s0461.18"/>
</product>

component-name.component

Any number of component files that each indicate the presence of an installed component, which is part of the product. Data in the file indicates the component build date, build version, component name, and product version. For example, the file might be the activity.component file, which indicates that the activity component is installed. The activity component is part of the ND product. An example of the file follows:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE component PUBLIC "componentId" "component.dtd">
<component build-date="05/31/06" build-version="a0522.07" 
   name="activity" spec-version="6.1.0.0"/>

extension.id.extension

Any number of extension files that each indicate the presence of an extension that you install as a user extension, as part of a service engagement, or as installed by a third party product. The <extension.id>.extension files are not created, logged, or removed by WAS products.

ptf-id.ptf

Any number of maintenance package files that each indicate the presence of an installed refresh pack, fix pack, or interim fix.

XML files in...

properties/version/history

...that store version history information files:The following XML files in the properties/version/history directory describe refresh packs, fix packs, and interim fixes that are currently installed. These XML files are related to installation items by the primary ID information, which is shown in the following examples as italicized text.

xxxmaintenance_package_identifierxxx.ptfDriver

A driver file has useful information about the entire contents of an interim fix or fix pack.

xxxmaintenance_package_identifierxxx.ptfApplied

The applied file has relevant information about the interim fixes or fix packs that are currently applied.

event.history

One file that lists update events that have occurred. An update event is an operation that installs or uninstalls an interim fix or a fix pack. The file is sorted by the date and time of the events that are listed.

 

Reports

WAS provides the ability to generate Version reports and History reports from the data in the files. The following report-generation scripts are available in the app_server_root bin directory.

Product version reports The following report generation scripts extract data from XML data files in the properties/version folder:

• versionInfo script

  Lets you use parameters to create a version report on platforms such as AIX or Linux, or on Windows platforms.

• genVersionReport script

  Generates the versionReport.html report file in the bin directory on platforms such as AIX or Linux, or on Windows platforms. The report includes the list of components and installed and uninstalled maintenance packages.

Product history reports

The following report generation scripts extract data from XML data files in the properties/version/history folder:

• historyInfo script

  Lets you use parameters to create a history report on platforms such as AIX or Linux, or on Windows platforms.

• genHistoryReport script

  Generates the historyReport.html report file in the bin directory on platforms such as AIX or Linux, or on Windows platforms. The report includes the list of components and a history of installed and uninstalled maintenance packages.

 

Logs and component backups

WAS products use two other directories when performing update operations, for logging and backups:

app_server_root /logs/update

The logs directory for product updates.

The location of log files that describe events that occur during the use of the update installer program.

app_server_rootproperties/version/backup

Product updates backup directory

WAS products back up components before applying interim fixes and fix packs. If you uninstall an interim fix or fix pack, WAS products restore the backed-up component JAR file.

File naming convention

Time stamp

YYYYMMDD_HHMMSS

For example: 20050324_211832 is 24-Mar-2004, 9:18:32 pm, GMT. All time stamps are in GMT.

ID

Interim fix ID or fix pack ID

For example: apar6789c is an interim fix ID; PTF_1 is a fix pack ID.

Operation

install | uninstall

Interim fix log file names

timeStamp_fixID_operation.log

For example, the Update installer program creates these logs: app_server_rootlogs/update/20050324_211832_apar6789c_install.log and app_server_root/logs/update/ 20050324_211912_apar6789c_uninstall.log

Interim fix component log file names

timeStamp_fixId_componentName_operation.log

For example, the update installer program creates these logs: app_server_root/logs/update/20050324_211832_apar6789c_ras_install.log and app_server_root/logs/update/ 20050324_211912_apar6789c_ras_uninstall.log

Fix pack log file names

timeStamp_ptfId_operation.log

For example, the update installer program creates these logs: app_server_root/logs/update/20050924_211832_was60_fp1_install.log and app_server_root/logs/update/ 20050924_211912_was60_fp1_uninstall.log

Fix pack component log file names

timeStamp_ptfId_componentName_operation.log

For example, prior to Fix Pack 2: properties/version/log/20050324_211832_was50_fp1_ras_install.log and properties/version/log/20030325_211912_was50_fp1_ras_uninstall.log The update installer program creates these logs: app_server_root/logs/update/20050324_211832_was60_fp1_ras_install.log and app_server_root/logs/update/20030325_211912_was60_fp1_ras_uninstall.log

Backup JAR file names

timeStamp_ptfId_componentName_undo.jar or timeStamp_fixId_componentName_undo.jar

For example: 20020924_211832_apar6789c_ras_undo.jar Do not delete a backup JAR file. You cannot remove a component update if the corresponding backup JAR file is not present.

Update processing might also use a temporary directory if necessary. A Java property specifies this directory as described in the next section.

 

Directory locations

Product information files are located relative to the WebSphere Application Server product app_server_root, or the server root directory. Default file paths are:

Vdirectory

app_server_root/properties/version

History directory

app_server_root/properties/version/history

Updates log directory

The update installer program stores log files in the app_server_root/logs/update directory.

Updates backup directory

app_server_root/properties/version/backup

DTD directory

app_server_root/properties/version/dtd

Temporary directory

Specified by the java.io.tmpdir Java system property

 

Operational description

WAS products update the product version history information while performing events that install or uninstall fixes or fix packs. Events that might occur include:

• A WAS product removes an interim fix file from the version directory when it uninstalls the corresponding fix.

• A WAS product adds a file with an extension of .ptf to the version directory to indicate than a refresh pack, a fix pack, or an interim fix is currently installed.

• A WAS product removes a file with an extension of .ptf from the version directory when it uninstalls the corresponding refresh pack, a fix pack, or an interim fix.

• A WAS product adds a driver file with an extension of .ptfDriver to the version/history directory when you run the historyInfo command. A fix pack driver file contains defining information for a fix pack.

• A WAS product adds a fix pack applied file with an extension of .ptfApplied to the version/history directory when when you run the historyInfo command. A fix pack application file contains information that identifies component updates applied for a fix pack. The application file also provides links to component log and backup files.

• A WAS product makes entries in the history file, event.history, when it installs or uninstalls a maintenance package.

• A WAS product writes a line about a parent event for each refresh pack, a fix pack, or interim fix that it installs or uninstalls.

• A WAS product stores child component events for each component update that it installs or uninstalls, beneath the corresponding interim fix, fix pack, or refresh pack parent event.

• A WAS product stores one log file in the logs/update directory as it installs or uninstalls one interim fix, fix pack, or refresh pack.

• A WAS product stores one log file in the logs/update directory as it installs or uninstalls an interim fix, fix pack, or refresh pack in response to each component update that occurs.

• A WAS product stores a component backup file in the backup directory for each component update that it installs.

• A WAS product removes a component backup file from the backup directory for each component update that it uninstalls.

 

Data dictionary

Type Family: WebSphere product family

File Types:

websphere

File Type:

websphere

Elements:

name                  string     required version               string     required

Persistence:

versionDir/platform.websphere

Type Detail:

The websphere file denotes the presence of WebSphere family products.

Element Detail:

websphere.name           The WebSphere product family name. websphere.version        The WebSphere product family version.


Type Family:      product

File Types:       product
                  component
                  extension

File Type:        product

Persistence:      versionDir/WAS.product

Elements:         id                    string     required
                  name                  string     required
                  version               string     required
                  build-info            complex    required

Type Detail:

A product file is placed to denote the presence of a specific WebSphere family product. WAS ID is embedded in the product file name.

Element Detail:
 product.id               The id of the product. product.name             The name of the product. product.version          The version of the product. product.build-info       An element containing build information for
                         the product.

Element Type:     build-info

Elements:         date                  date       required
                  level                 string     required

Type Detail:

A build-info instance details the build of a specific installed WebSphere family product.

Element Detail:
 build-info.date          The date on which the product was build. build-info.level         The level code of the product's build.

File Type:        component

Persistence:      versionDir/name.component

Elements:         name                  string     required
                  spec-version          string     required
                  build-version         string     required
                  build-date            date       required

File Detail:

A component file denotes the presence of a specific component.
The component name is embedded in the component file name.

Element Detail:
 component.name           The name of the component. component.spec-version   The specification version of the component. component.build-version  The build level of the component. component.build-date     The build date of the component.


Type Family:      update

File Types:       ptf
                  ptf-applied

File Type:        ptf

Persistence:      versionDir/id.ptf

Elements:         id                    string     required
                  short-description     string     required
                  build-version         string     required
                  build-date            date       required
                  component-name        complex    min=1, max=unbounded

Type Detail:

A ptf file denotes the presence of some portion of a specific refresh pack, fix pack, or interim fix.

The id of the refresh pack, fix pack, or interim fix is embedded in the fix pack file name.

A ptf file contains a listing of component updates.
 When installing a refresh pack, fix pack, or interim fix, you can omit certain potential component updates, but only when the corresponding component is not installed.

Examine a separate application file to determine the components that a particular refresh pack, fix pack, or interim fix updates.

A refresh pack or fix pack can include updates for a number of interim fixes.


Element Detail:
 ptf.id                   The ID of the fix pack.
 ptf.short-description    A short description of the fix pack.
 ptf.build-version        The build version of the fix pack.
                         This is distinct from the build version of
                         component updates contained within the fix pack.
 ptf-build-date           The build date of the fix pack.  This is distinct
                         from the build version of the component updates
                         contained within the
                         fix pack.
 ptf.component-name       A list of components.



File Type:        ptf-applied

Persistence:      versionDir/id.ptfApplied

Elements:         ptf-id                string     required
                  component-applied     complex    min=0, max=unbounded

Type Detail:

A ptf-applied collection specified what components have been updated for the refresh pack, fix pack, or interim fix as specified by the ID.

Element Detail:
 ptf-applied.ptf-id         The ID of the refresh pack, fix pack, or interim fix
                           for which applieds are recorded.
 ptf-applied.component-applied  The list of recorded applications.

Element Type:     component-applied

Elements:         component-name        string     required
                  update-type           enum       required [enumUpdateType]
                  log-name              anyURL     required
                  backup-name           anyURL     required
                  time-stamp            date       required

Type Detail:

An applied instance is present to indicate the application of an update for a particular interim fix, fix pack, or refresh pack to a particular component.
 (The particular interim fix, fix pack, or refresh pack is specified by the applied parent.)  An applied provides sufficient information to undo itself.

The elements of an applied are copies of values from update events.

Element Detail:
 component-applied.component-name   The name of the component which was updated.
 component-applied.update-type      The type of the component update.
 component-applied.log-name         The name of the log file that was generated by 
                                   this application.
 component-applied.backup-name      The name of the backup file that was generated by
                                   this application.
 component-applied.time-stamp       The time of this application (the ending time of
                                   the corresponding update event).



Enum Type:        enumUpdateType

Values:           0 add
                  1 replace
                  2 remove
                  3 patch

Type Detail:

An update type instance specifies the type of an update.  An 'add' update adds a component into an installation.  A 'replace' update replaces a particular version of a component with a different version of that component.  A 'remove' update removes a component.  A 'patch' update performs a limited update to a component, in particular, without changing the version of the component.
 When adding a component, that component may not already be present. When replacing or removing a component, that component must be present. When patching a component, that component must be present.
 When replacing or removing a component, or when patching a component, usually, at least one version prerequisite will be specified for the component update.

Value Detail:
 enumUpdateType.add       Specifies that an update adds a component.
 enumUpdateType.replace   Specifies that an update replaces a component.
 enumUpdateType.remove    Specifies that an update removes a component.
 enumUpdateType.patch     Specifies that an update modifies a component, but
                         does not change its version.


Type Family:      history

File Type:        event-history

Persistence:      historyDir/event.history

Elements:         update-event          complex    min=0, max=unbounded

Type Detail:

One event history is provided for a websphere product family installation.
This event history contains history of update events, corresponding with the actual update events for that product family.

Element Detail:
 event-history.update-event  The list of update events for the websphere
                            product family.  The top level events are refresh pack,
                            fix pack, and interim fix events, each containing one 
                            or more component events.

Element Type:     update-event

Elements:         event-type            enum       required [enumEventType]
                  parent-id             string     required
                  id                    string     required
                  update-type           enum       required [enumUpdateType]
                  primary-content       anyURI     required
                  update-action         enum       required [enumEventAction]
                  log-name              anyURI     required
                  backup-name           anyURI     required
                  start-time-stamp      dateTime   required
                  result                string     required
                  update-event          complex    optional

Type Detail:

An update event denotes a single update action, applying to either a fix, a fix pack, a refresh pack, or a component, according to the set  event type.

Element Detail:
 update-event.event-type        The type of this event, either a refresh pack, fix 
                               pack, or an interim fix type event, or a component 
                               type event.
 update-event.parent-id         This element is present only for component
                               events. The ID of the parent interim fix, fix 
                               pack, or refresh pack of this event.
 update-event.id                The ID of the interim fix, fix pack, refresh pack, 
                               or component that was updated, interpreted according 
                               to the type of the event.
 update-event.update-type       The type of update for an update event.
 update-event.update-action     The type of action for this event.
 update-event.log-name          The name of the log file that was generated
                               for this event.
 update-event.backup-name       The name of the backup file that was generated
                               for this event.
 update-event.start-time-stamp  The XML timestamp of the starting time of the
                               event.  This timestamp follows the XML timestamp
                               format, meaning that time zone information is
                               included.
 update-event.result            The result of the update.
 update-event.update-event      A collection of child events.  This collection is
                               used for interim fix and fix pack type events.  
                               This collection is empty for component type events.


Type Detail:

An event type instance specifies the type of an update event, which is either a refresh pack, fix pack, or interim fix (ptf) event or a component event. The  interpretation of particular event elements depends on the set event type.

Value Detail:

EventType.ptf        Specifies that an event is for a refresh pack, fix pack,
                     or interim fix update.

EventType.component  Specifies that an event is for a component update.

Enum Type:        update-action

Values:           0 Install
                  1 Uninstall

Type Detail:

An event action instance specified the operation performed by an update, which can be an install or uninstall operation.


Value Detail:
 enumEventAction.install              Specifies that an event is an install
                                     operation.
 enumEventAction.uninstall            Specifies that an event is an uninstall
                                     operation.

Enum Type:        enumUpdateType

Values:           0 Add
                  1 Replace
                  2 Remove
                  3 Patch

Type Detail:

An update type instance specifies the type of a component update.  

An 'add' update adds a component into an installation.  

A 'replace' update replaces a particular version of a component with  a different version of that component.

A 'remove' update removes a component.  

A 'patch' update performs a limited update to a component,  in particular, without changing the version of the component.

To add a new component, the component must not exist. 
To replace or remove a component, the component must exist. 
To patch a component, the component must exist.
 When replacing or removing a component, or when patching a component,  usually, at least one version prerequisite is specified for the  component update.

Value Detail:
 enumUpdateType.add       Specifies that an update adds a component.
 enumUpdateType.replace   Specifies that an update replaces a component.
 enumUpdateType.remove    Specifies that an update removes a component.
 enumUpdateType.patch     Specifies that an update modifies a component, but
                         does not change its version.

Enum Type:        enumEventResult

Values:           0 Succeeded
                  1 Failed
                  2 Cancelled

Type Detail:

An event result instance denotes a particular result for an update event. 
The result indicates success, failure, or cancellation.

Value Detail:
 enumEventResult.succeeded  Specifies that the operation was successful.
 enumEventResult.failed     Specifies that the operation failed.
 enumEventResult.cancelled  Specifies that the operation was cancelled.

---

 

Related tasks

Task overview: Installing

 

Related information

versionInfo command
genVersionReport command
historyInfo command
genHistoryReport command