Upgrade utility
Prev Chapter 14. Reference Next

Upgrade utility

TIBCO BusinessEvents® Extreme ships with an upgrade utility that is used during development to generate an upgrade plan used to deploy new versions of an application to TIBCO BusinessEvents® Extreme nodes. See Chapter 8, Cluster Upgrades for details on how the upgrade utility is used to upgrade applications.

The upgrade utility is executed from the command line. It is named upgrade.jar.

The general syntax for using the upgrade utility is:

java -jar upgrade.jar help  // display usage message
java -jar upgrade.jar [options]

upgrade.jar must be executed using the -jar option to a Java executable.

Table 14.2, “Upgrade utility options” summarizes the supported upgrade utility options:

Table 14.2. Upgrade utility options

OptionDescription
currentA : separated list of all directories where the current application JAR files can be found. This is a required option.

Note: JVM-specific deployment directories are not automatically found by the upgrade utility. If they are being used, they must be explicitly listed.

debugAn enumeration indicating the level of diagnostic output. The valid values are enable - a high level description of the upgrade utility activity, verbose - detailed description of upgrade utility activity, or none - no diagnostic output. (default: none).
upgradefileOptional upgrade plan file name. Default value is upgrade.<date> If the upgrade plan file already exists, a numeric value will be appended to make the file name unique.
replacementA : separated list of directories where the replacement application JAR files can be found. This is a required option.

Note: JVM-specific deployment directories are not automatically found by the upgrade utility. If they are being used, they must be explicitly listed.


The directories specified in the current and replacement options must contain all framework and application JAR files used by the application. The only exceptions are the directories containing the JDK and the TIBCO BusinessEvents® Extreme SDK, i.e. deploy.jar, do not need to be specified. An error is reported by the upgrade utility if a class cannot be resolved. For example,

FAILURE: AUDIT: com/kabira/examples/chat/ActiveUser
Problem finding or parsing parent class com.kabira.businessstatemachine.Process 
   in the current JAR files.
Prev Up Next
Deployment tool Home Supported JVM properties