IBM Support

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

Question & Answer


Question

How do you make the required updates to any existing profiles after applying IBM Business Process Manager interim fixes?

Answer

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


If an interim fix updates a product application or the configuration files, the existing profiles must 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. To update the profiles for an interim fix, run the BPMConfig command with the -upgrade -profile profile_name command-line options for each profile in the topology. The profile_name variable refers to the name of the profile in your environment.


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

Table of Contents:



Updating a stand-alone profile for an interim fix

  1. Stop the stand-alone server.

  2. Back up 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 value 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 BPMConfig -upgrade -profile <profileName> command. Go to the <install_root>/bin directory on Linux and UNIX-based operating systems or the <install_root>\bin directory on Windows operating systems.
    • On Linux and UNIX-based operating systems, the syntax is BPMConfig.sh -upgrade -profile <stand-alone_profile_name>

    • On Windows operating systems, the syntax is BPMConfig.bat -upgrade -profile <stand-alone_profile_name>


      If an interim fix updates any product applications or the configuration files, the BPMConfig command with the -upgrade option updates the respective product application or updates to the required configuration changes to the specified profile.


      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. The <profile_root>vairable is the root directory of the stand-alone profile and the <timestamp> variable is the time stamp when the BPMConfig command was run.

  4. Review the instructions that are specific to the interim fix that is being applied to determine if there are additional application steps, such as database updates or manual steps. If there are additional application steps, follow those steps in the interim fix application instructions.

  5. Start the stand-alone server.


Updating profiles in a network deployment environment for an interim fix

  1. Stop all servers, including node agents and the deployment manager, in the topology.

  2. Back up 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 value 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 BPMConfig -upgrade -profile <profileName> command for each profile in the topology. You can process the deployment manager profile and the managed node profiles in any order, but you must run the command for all profiles in your topology. Go to the <install_root>/bin directory on Linux and UNIX-based operating systems or the <install_root>\bin directory on Windows operating systems.

    • On Linux and UNIX-based operating systems, the syntax is BPMConfig.sh -upgrade -profile <profileName>

    • On Windows operating systems, the syntax is BPMConfig.bat -upgrade -profile <profileName>


      If an interim fix updates any product applications or the configuration files on the deployment manager, this command updates the respective product application or completes the required configuration changes for the deployment manager, clusters, and cluster members.


      Note: On the deployment manager, 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. The <profile_root> variable is the root directory of the deployment manager profile and the <timestamp>variable is the time stamp when the BPMConfig command was run.

  4. Review the instructions that are specific to the interim fix that is being applied to determine if there are additional application steps, such as database updates or manual steps. If there are additional application steps, follow those steps in the interim fix application instructions.

  5. Start all servers in the topology, beginning with the deployment manager and the node agents. Let the node synchronization finish before starting the cluster member servers. Depending on the number and size of the enterprise application archive (EAR) files that are being updated by an interim fix, it might take a while before updates have been distributed to and extracted on every managed node.


Removing stand-alone profile updates for an interim fix


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

To remove profile updates from a stand-alone profile, restore a profile.
  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, 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, you can export those applications from the administrative console and reinstall them after you run the restoreConfig command.


    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.

  4. Review the instructions that are specific to the interim fix that is being removed to determine if there are additional removal steps. If there are additional removal steps, follow those steps in the interim fix removal instructions.

  5. Start the stand-alone server.


Removing network deployment environment profile updates for an interim fix


If an interim fix is uninstalled, you must reverse any profile updates that were made when the interim fix was installed.
  1. Stop all servers, including node agents and the deployment manager, in the topology.

  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, you can export those applications from the administrative console and re-install them after running the restoreConfig command.


    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 that are specific to the interim fix that is being removed to determine if there are additional removal steps. If there are additional removal steps, follow those steps in the interim fix removal instructions.

  5. Restart all the servers in the topology, beginning with the deployment manager and the node agents. Let node synchronization finish before starting the cluster members.


References


Files that record the progress of the BPMConfig command are located in the <install_root>/logs/config directory. The files have names that include BPMConfig_<date>-<timeStamp>.log.

The following command references apply when you use IBM Business Process Manager V8.5 and V8.6:

[{"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.6;8.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.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.6;8.5","Edition":"","Line of Business":{"code":"LOB36","label":"IBM Automation"}}]

Product Synonym

BPM

Document Information

Modified date:
15 June 2018

UID

swg21637449