IBM Support

Profile update instructions for IBM Business Process Manager (BPM) 7.5.x and 8.0.x interim fixes

Question & Answer


Question

How do you make the required updates to a profile after applying IBM Business Process Manager interim fixes?

Answer

Note: This document is for IBM Business Process Manager Version 7.5 and Version 8.0 only. For instructions for Version 8.5, see the Profile update instructions for IBM Business Process Manager (BPM) interim fixes document.

If an interim fix updates an “infrastructure application” (product application) or the configuration files, then the profile needs to be updated to incorporate the application or updates to the configuration files. This additional step is needed after the interim fix package is applied using IBM Installation Manager. The BPMProfileUpgrade command is used to apply the profile updates for an interim fix.

If you customized the Process Portal themes, be aware that when you run the BPMProfileUpgrade command, it changes the import settings for Business Space system artifacts in the oobLoadedStatus.properties file, and overwrites your customizations. Before running BPMProfileUpgrade back up your customizations. Then, reimport and merge the customizations with the deployed theme after completing the upgrade process.

The profile update process differs based on whether you are using a stand-alone server or network deployment environment.


Instructions are also provided for removing interim fix updates from a profile.
For information about the BPMProfileUpgrade log file location and additional command references, refer to the References section.


Updating a stand-alone profile for an interim fix


To update a stand-alone profile, backup the profile and then run the BPMProfileUpgrade command for the profile. Detailed instructions are provided in the following steps:
  1. Stop the stand-alone server.
  2. Backup the stand-alone profile using the backupConfig command.
    • Run the backupConfig command from the installation root directory for IBM Business Process Manager.
      Note: This directory is not the root directory for a profile.

    • On Linux and UNIX-based operating systems, the syntax is bin/backupConfig.sh <backup_file_name> -profileName <stand-alone_profile_name>
    • On Windows operating systems, the syntax is bin\backupConfig.bat <backup_file_name> -profileName <stand-alone_profile_name>
    • The backup_file_name parameter specifies the full path to a backup .zip file, such as /ProfileBackups/profile_name_preJR12345.zip on Linux and UNIX-based operating systems or C:\ProfileBackups\profile_name_preJR12345.zip on Windows operating systems.

  3. Run the BPMProfileUpgrade command to update the stand-alone profile.
    • Change to the installation root directory for IBM Business Process Manager if this is not the current working directory.
    • On Linux and UNIX-based operating systems, the syntax is bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName <stand-alone_profile_name> -Dupgrade=true
    • On Windows operating systems, the syntax is bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName <stand-alone_profile_name> -Dupgrade=true
    • On Windows 7 and Windows Server 2008 operating systems, select Run as administrator when you open a command window that will be used to run the BPMProfileUpgrade command. This approach can help avoid possible privilege issues.

      Note: This command automatically creates a backup of any modified IBM Business Process Manager Standard configuration files such as 00Static.xml and 99Local.xml in the <profile_root>/configBackup.<timestamp> directory where <profile_root> is the root directory of the stand-alone profile and <timestamp> is the time stamp when the BPMProfileUpgrade command was run.
      Note: Dash characters might not copy correctly from the BPMProfileUpgrade syntax explanation to a command line environment. Even if the dash characters show as expected, the dashes might not be interpreted as expected in the command line environment. If there is an error after copying the BPMProfileUpgrade syntax explanation, then try typing the command in the command line environment.

  4. Review the instructions specific to the interim fix being applied to determine if there are additional application steps, such as database updates or manual steps. If there are additional application steps, then follow those steps in the interim fix application instructions. If there are no additional steps, then start the stand-alone server.


Updating profiles in a network deployment environment for an interim fix




To update a network deployment environment, backup the deployment manager profile, run the BPMProfileUpgrade command for the deployment manager, run the BPMProfileUpgrade command for all federated nodes, and run the BPMProfileUpgrade command for all clusters. Detailed instructions are provided in the following steps:
  1. Stop the network deployment environment, including clusters, node agents, and the deployment manager.

  2. Backup the deployment manager profile using the backupConfig command.
    • Run the backupConfig command from the installation root directory for IBM Business Process Manager that supports the deployment manager.
      Note: This directory is not the root directory for a profile.
    • On Linux and UNIX-based operating systems, the syntax is bin/backupConfig.sh <backup_file_name> -profileName <deployment_manager_profile_name>
    • On Windows operating systems, the syntax is bin\backupConfig.bat <backup_file_name> -profileName <deployment_manager_profile_name>
    • The backup_file_name parameter specifies the full path to a backup .zip file, such as /ProfileBackups/dmgr_preJR12345.zip on Linux and UNIX-based operating systems or C:\ProfileBackups\dmgr_preJR12345.zip on Windows operating systems.

  3. Run the BPMProfileUpgrade command to update the deployment manager.
    • Change to the installation root directory for IBM Business Process Manager that supports the deployment manager.
      Note: This directory is not the root directory for a profile.
    • On Linux and UNIX-based operating systems, the syntax is bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName <deployment_manager_profile_name> -Dupgrade=true
    • On Windows operating systems, the syntax is bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName <deployment_manager_profile_name> -Dupgrade=true
    • On Windows 7 and Windows Server 2008 operating systems, select Run as administrator when you open a command window that will be used to run the BPMProfileUpgrade command. This approach can help avoid possible privilege issues.

      Note: This command automatically creates a backup of any modified IBM Business Process Manager Standard configuration files such as 00Static.xml and 99Local.xml in the <profile_root>/configBackup.<timestamp> directory where <profile_root> is the root directory of the deployment manager profile and <timestamp> is the time stamp when the BPMProfileUpgrade command was run.
      Note: Dash characters might not copy correctly from the BPMProfileUpgrade syntax explanation to a command line environment. Even if the dash characters show as expected, the dashes might not be interpreted as expected in the command line environment. If there is an error after copying the BPMProfileUpgrade syntax explanation, then try typing the command in the command line environment.

  4. Start the deployment manager profile.

  5. Run the BPMProfileUpgrade command to update federated nodes. If there are multiple federated nodes, then run this step for every node.
    • Change to the installation root directory for IBM Business Process Manager that supports the federated node.
      Note: This directory is not the root directory for a profile.
    • On Linux and UNIX-based operating systems, the syntax is bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName <node_profile_name> -Dupgrade=true -Duser=<userID> -Dpassword=<password>
    • On Windows operating systems, the syntax is bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName <node_profile_name> -Dupgrade=true -Duser=<userID> -Dpassword=<password>
    • The -Duser and -Dpassword parameters are required because WebSphere administrative security is enabled. The -Duser parameter should be set to a user with administrative authority; the -Dpassword parameter is the password for this user.
    • On Windows 7 and Windows Server 2008 operating systems, select Run as administrator when you open a command window that will be used to run the BPMProfileUpgrade command. This approach can help avoid possible privilege issues.

  6. Stop the deployment manager profile.

  7. Run the BPMProfileUpgrade command to update clusters. If there are multiple clusters, then run this step for every cluster.
    • Change to the installation root directory for IBM Business Process Manager that supports the deployment manager.
      Note: This directory is not the root directory for a profile.
    • On Linux and UNIX-based operating systems, the syntax is bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName <deployment_manager_profile_name> -Dupgrade=true
      -Dcluster=
      <cluster_name>
    • On Windows operating systems, the syntax is bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName <deployment_manager_profile_name> -Dupgrade=true
      -Dcluster=
      <cluster_name>
    • On Windows 7 and Windows Server 2008 operating systems, select Run as administrator when you open a command window that will be used to run the BPMProfileUpgrade command. This approach can help avoid possible privilege issues.

  8. Review the instructions specific to the interim fix being applied to determine if there are additional application steps, such as database updates or manual steps. If there are additional application steps, then follow those steps in the interim fix application instructions. If there are no additional steps, then start the network deployment environment, including the deployment manager, node agents, and clusters.


Removing stand-alone profile updates for an interim fix


If you uninstall an interim fix, then you must reverse any profile updates that you made when the interim fix was installed

To remove profile updates from a stand-alone profile, either restore a profile backup or use the BPMProfileUpgrade command to restore applications. Step three in the following steps provides details on both methods including the considerations for selecting a method.
  1. Stop the stand-alone server.

  2. Make sure that the interim fix has been uninstalled using IBM Installation Manager.

  3. If the profile was backed up using the backupConfig command, then use the restoreConfig command to restore the profile.
    • Note: The restoreConfig command returns the profile to its state when the backup was taken using the backupConfig command. If you have installed additional custom applications since the backup was taken, then you can export those applications from the administrative console and reinstall them after you run the restoreConfig command. If there have been other configuration changes that would be difficult to redo, then you can run the BPMProfileUpgrade command as an alternative. However, if you choose the BPMProfileUpgrade command, note that applications are returned to their state prior to interim fix application but configuration file changes made by an interim fix are not undone. Manual instructions specific to a particular interim fix need to be followed if the interim fix made configuration file changes.
    • Run the restoreConfig command from the installation root directory for IBM Business Process Manager. Note: This directory is not the root directory for a profile.
    • On Linux and UNIX-based operating systems, the syntax is bin/restoreConfig.sh <backup_file_name> -profileName <stand-alone_profile_name>
    • On Windows operating systems, the syntax is bin\restoreConfig.bat <backup_file_name> -profileName <stand-alone_profile_name>
    • The backup_file_name parameter specifies the full path to a backup .zip file, such as /ProfileBackups/profile_name_preJR12345.zip on Linux and UNIX-based operating systems or C:\ProfileBackups\profile_name_preJR12345.zip on Windows operating systems.


      Otherwise, run the BPMProfileUpgrade command to restore applications, but not configuration files changes if the interim fix changed configuration files, to their prior state.

    • Change to the installation root directory for IBM Business Process Manager.
      Note: This directory is not the root directory for a profile.
    • On Linux and UNIX-based operating systems, the syntax is bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName <stand-alone_profile_name> -Dupgrade=true
    • On Windows operating systems, the syntax is bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName <stand-alone_profile_name> -Dupgrade=true
    • On Windows 7 and Windows Server 2008 operating systems, select Run as administrator when you open a command window that will be used to run the BPMProfileUpgrade command. This approach can help avoid possible privilege issues.

  4. Review the instructions that are specific to the interim fix being removed to determine if there are additional removal steps. If there are additional removal steps, then follow those steps in the interim fix removal instructions. If there are no additional steps, then start the stand-alone server.


Removing network deployment environment profile updates for an interim fix


If an interim fix is uninstalled, then profile updates made when the interim fix was installed must be reversed. The process of removing profile updates differs based on whether a deployment manager profile backup was taken.

If there is a deployment manager profile backup that was created using the backupConfig command, then follow these steps to remove profile updates from a network deployment environment.
  1. Stop the network deployment environment, including clusters, node agents, and the deployment manager.

  2. Make sure that the interim fix has been uninstalled using IBM Installation Manager. The interim fix must be uninstalled from all installations that support profiles in the environment.

  3. Use the restoreConfig command to restore the deployment manager profile.
    • Note: The restoreConfig command returns the profile to its state when the backup was taken using the backupConfig command. If additional custom applications have been installed since the backup was taken, then you can export those applications from the administrative console and re-install them after running the restoreConfig command. If there have been other configuration changes that would be difficult to redo, then you can run the BPMProfileUpgrade command as an alternative. However, if the BPMProfileUpgrade command is chosen, note that applications are returned to their state prior to interim fix application but configuration file changes made by an interim fix are not undone. Manual instructions specific to a particular interim fix need to be followed if the interim fix made configuration file changes.
    • Run the restoreConfig command from the installation root directory for IBM Business Process Manager that supports the deployment manager.
      Note
      : This directory is not the root directory for a profile.
    • On Linux and UNIX-based operating systems, the syntax is bin/restoreConfig.sh <backup_file_name> -profileName <deployment_manager_profile_name>
    • On Windows operating systems, the syntax is bin\restoreConfig.bat <backup_file_name> -profileName <deployment_manager_profile_name>
    • The backup_file_name parameter specifies the full path to a backup .zip file, such as /ProfileBackups/dmgr_preJR12345.zip on Linux and UNIX-based operating systems or C:\ProfileBackups\dmgr_preJR12345.zip on Windows operating systems.

  4. Review the instructions specific to the interim fix being removed to determine if there are additional removal steps. If there are additional removal steps, then follow those steps in the interim fix removal instructions and then return to this step. Continue by starting the deployment manager and node agents.

  5. If automatic node synchronization is enabled, then make sure the nodes have been synchronized with the deployment manager. Otherwise, manually synchronize the nodes with the deployment manager.

  6. Start the cluster members.

If there is not a deployment manager profile backup, then use the BPMProfileUpgrade command to restore applications (but not configuration files changes, if the interim fix changed configuration files) to their prior state.
  1. Stop the node agents and clusters. Leave the deployment manager running.

  2. Run the BPMProfileUpgrade command to downgrade federated nodes. If there are multiple federated nodes, then run this step for every node.
    • Change to the installation root directory for IBM Business Process Manager that supports the federated node.
      Note: This directory is not the root directory for a profile.
    • On Linux and UNIX-based operating systems, the syntax is bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName <node_profile_name> -Dupgrade=true -Duser=<userID> -Dpassword=<password>
    • On Windows operating systems, the syntax is bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName <node_profile_name> -Dupgrade=true -Duser=<userID> -Dpassword=<password>
    • The -Duser and -Dpassword parameters are required because WebSphere administrative security is enabled. The -Duser parameter should be set to a user with administrative authority; the -Dpassword parameter is the password for this user.
    • On Windows 7 and Windows Server 2008 operating systems, select Run as administrator when you open a command window that will be used to run the BPMProfileUpgrade command. This approach can help avoid possible privilege issues.

  3. Stop the deployment manager profile.

  4. Run the BPMProfileUpgrade command to downgrade clusters. If there are multiple clusters, then run this step for every cluster.
    • Change to the installation root directory for IBM Business Process Manager that supports the deployment manager.
      Note: This directory is not the root directory for a profile.
      On Linux and UNIX-based operating systems, the syntax is bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName <deployment_manager_profile_name> -Dupgrade=true –Dcluster=<cluster_name>
    • On Windows operating systems, the syntax is bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName <deployment_manager_profile_name> -Dupgrade=true
      –Dcluster=
      <cluster_name>
    • On Windows 7 and Windows Server 2008 operating systems, select Run as administrator when you open a command window that will be used to run the BPMProfileUpgrade command. This approach can help avoid possible privilege issues.

  5. Run the BPMProfileUpgrade command to downgrade the deployment manager.
    • Change to the installation root directory for IBM Business Process Manager that supports the deployment manager.
      Note: This directory is not the root directory for a profile.
    • On Linux and UNIX-based operating systems, the syntax is bin/ws_ant.sh -f util/BPMProfileUpgrade.ant -profileName <deployment_manager_profile_name> -Dupgrade=true
    • On Windows operating systems, the syntax is bin\ws_ant.bat -f util\BPMProfileUpgrade.ant -profileName <deployment_manager_profile_name> -Dupgrade=true
    • On Windows 7 and Windows Server 2008 operating systems, select Run as administrator when you open a command window that will be used to run the BPMProfileUpgrade command. This approach can help avoid possible privilege issues.

6. Review the instructions that are specific to the interim fix being removed to determine if there are additional removal steps. If there are additional removal steps, then follow those steps in the interim fix removal instructions and then return to this step. Continue by starting the deployment manager and node agents.


7. If automatic node synchronization is enabled, then make sure the nodes have been synchronized with the deployment manager. Otherwise, manually synchronize the nodes with the deployment manager.


8. Start the cluster members.


References


Files that record the progress of the BPMProfileUpgrade command are located in the <profile_root>/logs directory, where <profile_root> corresponds to the -profileName parameter value used when you run the BPMProfileUpgrade command. The files have names that include BPMProfileUpgrade.<profileName>.<timeStamp>. The primary file has a "log" extension. Additional details are included in the file with the "trace" extension and any errors are included in the file with the "error" extension.

The following command references apply when you use IBM Business Process Manager V7.5.
The following command references apply when you use IBM Business Process Manager V8.0

[{"Product":{"code":"SSFTN5","label":"IBM Business Process Manager Advanced"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Installation \/ Configuration","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"8.0.1;8.0;7.5.1;7.5","Edition":"","Line of Business":{"code":"LOB36","label":"IBM Automation"}},{"Product":{"code":"SSFTDH","label":"IBM Business Process Manager Standard"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Installation \/ Configuration","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"","label":"Linux zSeries"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"8.0.1;8.0;7.5.1;7.5","Edition":"","Line of Business":{"code":"LOB36","label":"IBM Automation"}},{"Product":{"code":"SSFTBX","label":"IBM Business Process Manager Express"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Installation \/ Configuration","Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"8.0.1;8.0;7.5.1;7.5","Edition":"","Line of Business":{"code":"LOB36","label":"IBM Automation"}}]

Product Synonym

BPM

Document Information

Modified date:
15 June 2018

UID

swg21608414