Upgrading an existing BMC Helix iPaaS integration template, powered by Jitterbit


BMC Helix iPaaS, powered by Jitterbit provides out-of-the-box integration templates that serve as a framework for your integration use case. After the integration templates are configured and deployed, use the templates for your integration use cases. Periodically, BMC may release an upgraded version of an existing integration template. The integration template is designed as a stand-alone implementation. Any version upgrades, including code revisions from BMC to an integration template, is a replacement for the existing template version. The updated JSON files are published on the BMC Electronic Product Distribution (EPD) site and are available for download.

For more information about upgrading an on-premises Jitterbit private agent, see the following documentation in the JItterbit documentation:

Before you begin

  • Review the 23-3-enhancements-and-patches to check the updates available for your integration template.
  • Make sure you have documented the configurations and customizations of the existing integration template.
  • Do not delete your existing deployment until you are ready to move your upgraded integration into production. 

Upgrade scenarios

Upgrade your existing integration template if you want to implement the new capabilities available with an updated template or if upgrades to any BMC Helix products affect your existing templates. To upgrade to the new version of an integration template, you must manually reapply all configurations and customizations made to your existing integration solution when configuring the upgraded integration template. 

The following image provides an overview of the upgrade scenarios for your integration template and shows the upgrade process:

templateUpgrade.png

Important

You can continue to use your existing integration template if you do not need the new features available with the upgraded integration template. However, if upgrades to the BMC Helix products require the BMC Helix iPaaS integration template to be updated, you must use the upgraded BMC Helix iPaaS integration template for your integration.

For more information about the new features available with the upgrade of an integration template, see Release-notes-and-notices.

To upgrade an existing integration template

To upgrade an existing template, you must download and reconfigure the upgraded version of the template.

Best practice
We recommend that you reapply all configurations and customizations in the development environment and test them in a QA environment before you move the integration into production. 

  1. In your development environment, download the JSON project file from the EPD website.
    This file contains the BMC Helix iPaaS Integration Studio project for the integration template. 

    Important

    Your ability to access product pages on the EPD website is determined by the license your company purchased.

  2. Import the downloaded file to the development environment where you want to add the project.
  3. Update the project variables. 

    Best practice
    We recommend you use the values defined in your deployed integration template. 

  4. Reapply any customizations you configured for your deployed integration template. 
  5. Move the configured integration template project to your QA environment, and then deploy and enable the project.
    For more information, see Deploy-and-enable-project.
  6. Perform a complete round of testing to ensure that the integration use cases are executed as expected after the customizations are reapplied. 
  7. Back up the existing integration template project from the production environment: 

    1. Log in to BMC Helix iPaaS and navigate to the Integration Studio.
    2. Select your production environment from the Filter by: list.
    3. Select the ellipses (...) in the Actions column of the project, and click Export.
    4. On the Export Project page, select all the available options and click Export.
      This creates a project JSON file with all the template configurations. 
  1. Move the tested integration template project to the production environment.
  2. Deploy and enable the new integration template project. 
    For more information, see Deploy-and-enable-project

    Warning

    The deployment overwrites the existing BMC Helix iPaaS APIs for your currently deployed and enabled integration project causing it to stop functioning. 

  3. Delete the existing integration template project.
    1. Log in to BMC Helix iPaaS and navigate to the Integration Studio.
    2. Select your production environment from the Filter by: list.
    3. Select the ellipses (...) in the Actions column of the project, and click Delete and then click Continue.
      The integration template project is deleted from your production environment.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*