Upgrade the Integration Bridge

Note: This topic is relevant for NextGen Synchronizer only. For details about the ALM Synchronizer, see ALM Synchronizer for Agile Manager or search using the ALM Synchronizer filter.

When a new Agile Manager version includes a new version of the Integration Bridge, any existing bridges automatically detect the need for upgrade.

The following process takes place without user intervention:

  • The existing bridge is disabled.

  • The new version of the Integration Bridge is downloaded and verified.

  • The new bridge is installed in place of the existing one and then enabled. Any previous configuration settings and security certificates are retained.

Email notifications are sent at the beginning and end of the upgrade. Upgrade notifications are sent to the Integration Administrator users that you specify on the bridge's Notification tab (Integrations > Synchronizer configuration page).

If, for some reason, you need to manually upgrade the Integration Bridge, use one of the following methods:

This procedure registers the upgraded bridge as an existing bridge.

  1. Uninstall the Integration Bridge, as described in Uninstall/Remove the Integration Bridge. During the uninstall process, do not select Remove credentials.

  2. Download the new version of the Integration Bridge from the Integrations > Link Configuration page.

    Select More Actions > Download Integration Bridge, and select the relevant download according to your operating system.

  3. Extract the downloaded zip file (hpe-integration-bridge-windows.zip or hpe-integration-bridge-linux.zip) to a new folder.

  4. Copy values from the previous installation to the new installation. Do the following:

    1. In the installation directory of the previous version, access the \product\conf\server-connection.bak file. (On a Linux system, reverse the slashes in the path.)

      Tip: By default, the installation directory is C:\Program Files\HPE\HPE Integration Bridge (Windows) or /root/HPE/HPE Integration Bridge (Linux).

    2. In a parallel window, browse to the server-connection.conf file downloaded with the new version of the Integration Bridge, and open it for editing.

    3. Copy the agent.guid property and its value from the previous installation file, and append it to the new file. Save the new file.

  5. Run the newly downloaded hpe-integration-bridge.exe (Windows) or hpe-integration-bridge.bin (Linux) to begin the installation.

    During the installation, select the installation folder that was used for the previous version.

    For more details, see Download and install the bridge.

This procedure installs the upgraded Integration Bridge in a new directory on the same server as the previous version, or on an entirely new machine.

  1. Uninstall the Integration Bridge, as described in Uninstall/Remove the Integration Bridge. During the uninstall process, do not select Remove credentials.

  2. Download the new version of the Integration Bridge from the Integrations > Link Configuration page.

    Select More Actions > Download Integration Bridge, and select the relevant download according to your operating system.

  3. Extract the downloaded zip file (hpe-integration-bridge-windows.zip or hpe-integration-bridge-linux.zip) to a new folder.

  4. Copy files and values from the previous installation to the new installation. Do the following:

    1. In the directory where you want to install the new version, create the following folder structure:product\conf

    2. Copy the following files from the installation directory of the previous version to the conf directory you created in the previous step.

      • credentialsStore.xml
      • key.bin

    3. In the installation directory of the previous version, access the \product\conf\server-connection.bak file. (On a Linux system, reverse the slashes in the path.)

      Tip: By default, the installation directory is C:\Program Files\HPE\HPE Integration Bridge (Windows) or /root/HPE/HPE Integration Bridge (Linux).

    4. In a parallel window, browse to the server-connection.conf file downloaded with the new version of the Integration Bridge, and open it for editing.

    5. Copy the agent.guid property and its value from the previous installation file, and append it to the new file. Save the new file.

  5. Run the hpe-integration-bridge.exe (Windows) or hpe-integration-bridge.bin (Linux) to begin the installation.

    During the installation, select the directory where you want to install the new version.

    For more details, see Download and install the bridge.

Both upgrade methods retain the configured endpoint credentials.

When performing a manual upgrade, if your Integration Bridge communicates with Agile Manager or ALM using a certificate that is not signed by a well-known Certificate Authority, you need to reinstall the certificate after upgrading the bridge. For details, see this topic.