Upgrade from Jitterbit v5.x to Harmony¶
Jitterbit version 5.x is the legacy Jitterbit product. Jitterbit strongly recommends that all customers upgrade to Jitterbit Harmony. For more information, see Getting Started.
This process is for upgrading Jitterbit version 5.x to Jitterbit Harmony using Design Studio. Design Studio includes tools to help you convert your 5.x projects to Harmony projects.
Jitterbit Harmony is the latest release in Jitterbit's history to simplify and accelerate enterprise integration. Harmony includes powerful new features for designing, deploying, and managing integrations for the modern enterprise.
This page covers all necessary tasks for upgrading your version 5.x projects to Jitterbit Harmony. For an overview of all the components of Harmony, see the Jitterbit Security and Architecture White Paper.
Getting Started with Harmony¶
For instructions on getting started with Harmony, refer to the Jitterbit Admin Quick Start Tutorial. This guide includes information on registering for Harmony and inviting team members, as well as a walkthrough to set up your first environment and Agent Group.
Upgrading the Design Application to Harmony¶
Harmony Design Studio must be used for upgrading your 5.x projects to Harmony. The Harmony Design Studio includes tools to help you convert your 5.x projects to Harmony projects.
If you do not need to upgrade your existing 5.x projects, another option is using our web-based Cloud Studio project designer to rebuild your projects from scratch.
Harmony Design Studio is available for download from the Harmony Portal:
- Log in to the Harmony Portal and choose Downloads.
- Download Design Studio. If the download is not available on this page, please contact your Customer Success Manager for access.
- Install Design Studio. Refer to System Requirements for additional information.
- Open the Design Studio application and create a new project. See Design Studio Quick Start Guide for more detailed instructions and walkthrough.
Upgrading the Jitterbit Integration Server to Harmony Agents¶
Jitterbit Harmony cannot be configured to connect to your existing Jitterbit Integration Server. Instead, you have the option of using Private Agents, Cloud Agents, or a hybrid deployment.
Upgrading to Private Agents¶
Existing Jitterbit Integration Servers cannot be upgraded or converted into Harmony Private Agents. A Jitterbit Harmony Private Agent is a separate installation. Private Agents are available for download from the Harmony Portal using the Downloads page.
Private Agents cannot be installed on the same physical or virtual machine where the Jitterbit Integration Server is installed. Jitterbit Private Agents includes a PostgreSQL database that is installed by default. You also have the option to install the Private Agent database into an existing PostgreSQL database. You should not, however, install the Jitterbit Harmony Agent database into an existing Integration Server database.
- Log in to the Harmony Portal and choose Downloads.
- Download and install the Private Agent. Refer to System Requirements for additional information, including installation instructions.
Upgrading to Cloud Agents¶
Cloud-to-cloud integrations can now be run on a Jitterbit Cloud Agent Groups. To run projects in the cloud, simply select a Jitterbit Cloud Agent Group as the Agent Group servicing your environment.
By doing this, all operations deployed in the environment will be run on the Jitterbit Cloud Agent Group.
You cannot use the Cloud Agent Group to run your projects if you:
Have any local file or file share sources or targets
Reuse the PostgreSQL database bundled with the Integration Server
Have custom plug-ins installed on the Integration Server
Have hosted web services in any of the projects
Use any plug-ins other than these:
OASIS Web Service Security
Private Cloud Agents¶
You can install Private Agents on private cloud services such as Amazon Web Services. Note, however, that Jitterbit Harmony agents cannot be installed on the same physical machine or virtual machine where the Jitterbit Integration Server is installed.
Upgrading and Deploying Existing Projects to Jitterbit Harmony¶
Harmony Design Studio automatically converts older Jitterbit projects created in Jitterbit Version 5.x into a format required for Jitterbit Harmony. This conversion is done when a version 5.x project is opened in Design Studio.
With Harmony, all projects are deployed to an environment. To deploy a converted project to an environment, simply select the environment to which the project needs to be deployed. You must create an environment before older projects can be converted.
Additional conversion steps are required for projects created in versions 4.x, 3.x, or 2.x. Projects created in versions 2.x must first be converted to version 3.6, then converted to 5.x, and then they may be upgraded to Harmony Design Studio. Projects created in versions 3.x or 4.x must be converted to version 5.x prior to upgrading them to Design Studio.
Harmony Design Studio supports the ability to import Jitterpaks created from versions 5.x of Jitterbit. Choose the Import Jitterpak option when the Harmony Design Studio is launched. You must create an environment before a project in a Jitterpak can be converted and deployed. Contact support for assistance if your projects were created in versions 2.x, 3.x or 4.x.
Additional conversion steps are required for Jitterpaks created in versions 4.x, 3.x, or 2.x. Jitterpaks created in versions 2.x must first be converted to version 3.6, then converted to 5.x, and then they may be imported/upgraded to Harmony Design Studio. Jitterpaks created in versions 3.x or 4.x must be converted to version 5.x prior to importing/upgrading them to Design Studio. Contact support for assistance if your projects were created in versions 2.x, 3.x or 4.x.
Considerations When Using the PGP Plug-in¶
The PGP plug-in has been re-designed with Harmony. With 5.3 or older versions of Jitterbit, the PGP plug-in requires the keys to be stored as files on the local disk (on the Integration Server). The path to the key file is then passed as input to the plug-in.
With Harmony, the PGP plug-in has been redesigned to take the key directly as input. As a result, you may have to modify the project accordingly.
One option is to put the key file on a separate location accessible in a secure manner such as Secure FTP or HTTPS, configure a corresponding Jitterbit source in the project, and call the
ReadFile function to get the key and pass it to the plug-in.
The PGP plug-in will still work with the local key files. You will have to modify your project only if you are moving from a local server to the Jitterbit Cloud Agent Group.