DBUpgrade command-line utility
Use the DBUpgrade command-line utility to upgrade previous versions of database schemas and data to the current version of IBM® BPM.
- 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.
You need to run the DBUpgrade command once for each deployment environment.
Prerequisites
- Before running the DBUpgrade command, make sure that the servers and cluster members are stopped.
- If you are migrating from an earlier version, the user name and password are taken from the target_migration_properties_file. The user name must have various WebSphere privileges. The WebSphere primary administrative user has them all. In the source environment, you can find the primary administrative user name in the administrative console by going to BPMConfig properties file. Use the user name and password for that alias. . In the target environment, if you do not have access to the administrative console, you can find bpm.de.authenticationAlias.#.name=CellAdminAlias in the
- In a DB2 high availability disaster recovery (HADR) environment, remove the
following line from the upgradeSchema_ProcessServer.sql script in
target_deployment_manager_profile/dbscripts/Upgrade/cell_name.de_name/database_type/Process_Server_database_name
before running the command.
By default, the DB2 blocknonlogged parameter is set to Yes for HADR that causes failure of the ALTER TABLE statement with the NOT LOGGED INITIALLY parameter. For more information, see the blocknonlogged - Block creation of tables that allow non-logged activity configuration parameter topic."ALTER TABLE psbpmdb.LSW_PO_VERSIONS ACTIVATE NOT LOGGED INITIALLY"
Location
The DBUpgrade command is in the install_root/bin directory, where install_root is the installation location of IBM Business Process Manager.
The logs are saved under the install_root/profiles/profile_name/logs directory in files named DBUpgrade_TimeStamp.log and bootstrapProcesServerData.AppClusterName.TimeStamp.log, where profile_name is the root of the stand-alone or deployment manager profile, or the profile directory that you specified for the profile.name property in the target_migration.properties file.
Syntax
- To migrate from an earlier version to IBM Business Process Manager
V8.5.6:
DBUpgrade -propertiesFile target_migration_properties_file -backupFolder snapshot_folder
- To upgrade from IBM Business Process Manager V8.5.x to V8.5.6:
- IBM BPM Advanced or Standard:
DBUpgrade -profileName deployment_manager_profile [-de deployment_environment_name]
- IBM BPM
Express:
DBUpgrade -profileName stand-alone_profile [-de deployment_environment_name]
- IBM BPM Advanced or Standard:
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. This parameter is required if you are migrating.
- -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.
- -profileName
- This parameter is the name of the deployment manager profile for IBM BPM Advanced or Standard, and the stand-alone profile for IBM BPM Express. This parameter is required if you are upgrading from IBM BPM V8.5.x.
- -de
- This parameter is the deployment environment name. This parameter is required only if you are upgrading from IBM BPM V8.5.x and you have more than one deployment environment configured in your WebSphere cell.
Examples
install_root/bin/DBUpgrade.sh -propertiesFile /opt/BPM85/util/migration/resources/target_migration.properties -backupFolder /tmp/snapshot
install_root\bin\DBUpgrade.bat -propertiesFile "C:\bpm 85\util\migration\resources\target_migration.properties" -backupFolder C:\snapshot
install_root/bin/DBUpgrade.sh -propertiesFile /opt/BPM85/util/migration/resources/target_migration.properties
install_root\bin\DBUpgrade.bat -propertiesFile "C:\bpm 85\util\migration\resources\target_migration.properties"
install_root/bin/DBUpgrade.sh -profileName DmgrProfile
install_root\bin\DBUpgrade.bat -profileName DmgrProfile -de DE1
Manually running the schema upgrade for the Process Server and Performance Data Warehouse databases
- Open the upgradeSchema_ProcessServer.sql file in target_deployment_manager_profile/dbscripts/Upgrade/cell_name.de_name/database_type/Process_Server_database_name.
- 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, V8.5.5, and finally V8.5.6. In that case, you must copy the SQL statements from /* START of phase ProcUpgradeTo751 */ to the end of the file.
- Run the SQL statements in your preferred database tool to perform all the database schema updates.
- Open the upgrade.xml file in
install_root/util/dbUpgrade. Search in the file for
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.<sysproperty key="data.upgrade" value="false" />