DBUpgrade command-line utility

The DBUpgrade command upgrades previous versions of database schemas and data to the current version of IBM® BPM.

Syntax

DBUpgrade -propertiesFile target_migration_properties_file [-backupFolder snapshot_folder]

Description

The DBUpgrade command updates the following items in the databases to IBM BPM V8.5.5:
  • System Data toolkit
  • Process Portal process application
  • Hiring Sample tutorial process application
  • Topology information in the Business Process Choreographer database
  • Schema and data for Process Server and Performance Data Warehouse databases, except for DB2 for z/OS databases. To manually run the schema update separately, see the instructions at the end of this topic.
Note: Although the DBUpgrade utility updates the System Data toolkit to IBM Business Process Manager V8.5.5, it does not automatically update existing dependencies. The dependencies are updated as part of the postmigration procedures.
If you are migrating from Teamworks 7.0.0 or 7.0.1, the DBUpgrade command converts encrypted passwords to work with the encryption algorithm used by IBM BPM V8.0.1. Encrypted passwords may be stored in the database for users defined through the WebSphere® Application Server file registry or for secure web service integrations.
Note: Encrypted passwords can be stored in the database for Microsoft SharePoint integrations users.

The DBUpgrade command is located in the install_root/bin/ directory (where install_root is the installation location of IBM Business Process Manager). Before running the command, make sure that the servers and cluster members are stopped.

You need to run the DBUpgrade command only once, even if you have multiple nodes and cluster members.

The logs are saved under the install_root/profiles/PROFILE_NAME/logs directory in files named DBUpgrade_TimeStamp.log and bootstrapProcesServerData.AppClusterName.TimeStamp.log. PROFILE_NAME is the value that you specified for the profile.name property in the target_migration.properties file.

Required parameters

-propertiesFile
This parameter is the full path to the target migration properties file in which you specified the configuration information for the target environment. The sample file is found in install_root/util/migration/resources/migration.properties. Ensure that the value of the target.config.property.file property is set to the full path of the configuration properties file that you used to create your target environment. You must also set the value of profile.name.
-backupFolder
This parameter is the snapshot directory that contains the information that was extracted from the source environment by the BPMExtractSourceInformation utility. This parameter is required if you are migrating from IBM BPM Advanced or WebSphere Process Server.

Examples

Examples for migrating from IBM BPM Advanced or WebSphere Process Server:
  • For Linux operating systemFor UNIX operating system install_root/bin/DBUpgrade.sh -propertiesFile /opt/BPM85/util/migration/resources/target_migration.properties -backupFolder /tmp/snapshot
  • For Windows operating system install_root\bin\DBUpgrade.bat -propertiesFile "C:\bpm 85\util\migration\resources\target_migration.properties" -backupFolder C:\snapshot
Examples for migrating from IBM BPM Standard or WebSphere Lombardi Edition:
  • For Linux operating systemFor UNIX operating system install_root/bin/DBUpgrade.sh -propertiesFile /opt/BPM85/util/migration/resources/target_migration.properties
  • For Windows operating system install_root\bin\DBUpgrade.bat -propertiesFile "C:\bpm 85\util\migration\resources\target_migration.properties"

Manually running the schema upgrade for the Process Server and Performance Data Warehouse databases

By default, DBUpgrade updates both the database schema and the data for the Process Server and Performance Data Warehouse databases. If you want your database administrator to run the schema upgrade manually for these two databases, complete the following steps to separate the schema and data updates:
  1. Open the upgradeSchema_ProcessServer.sql file in target_deployment_manager_profile/dbscripts/Upgrade/de_name/database_type/Process_Server_database_name.
  2. Find the phases in the file that correspond to your source. Each phase starts with /* START of phase ProcUpgradeToversion */ and ends with /* END of phase ProcUpgradeToversion */.

    For example, if your source version is V7.5.1, the database is upgraded to V8.0.0 first, and then to V8.0.1, V8.5.0, and finally V8.5.5. In that case, you must copy the SQL statements from /* START of phase ProcUpgradeTo751 */ to the end of the file.

  3. Run the SQL statements in your preferred database tool to perform all the database schema updates.
  4. Open the upgrade.xml file in install_root/util/dbUpgrade. Search in the file for
    <sysproperty key="data.upgrade" value="false" />
    By default, the value of the data.upgrade property is false, which means that both schema and data are upgraded. If the database schema has already been upgraded manually and you want to upgrade the data only, change this value to true before you run the DBUpgrade command. DBUpgrade will skip the schema upgrade and do the data upgrade only.