Skip to Content

Get Started with Jitterbit's Harmony


Jitterbit's Harmony is an enterprise integration platform-as-a-service (iPaaS). Use it to integrate systems, expose those integrations as APIs, build custom web and mobile apps, and process EDI (electronic data interchange) transactions.

To get started, follow these steps:

  1. Learn more about Harmony applications and components.

  2. Register a Harmony account.

  3. Log in to Jitterbit's Harmony Portal at and start using Harmony applications.

  4. (Optional) Administer your organization: configure organization settings, install privately hosted infrastructure, configure environments, and invite team members.

Applications and Components

Harmony applications provide the frontend design interface, while their platform components do the backend work to execute those designs at runtime. Communication between Harmony applications and the Harmony platform takes place via Harmony microservices.

harmony system architecture

Jitterbit's web-based Harmony applications are accessible through Jitterbit's Harmony Portal. You can use the latest versions of Google Chrome, Mozilla Firefox, or Apple Safari (macOS only) browsers to access them.

To communicate with the Harmony cloud platform, JavaScript must be enabled, and the HTTPS outbound port (443) must be open. (This is normally allowed by corporate server firewalls.)

The Security and Architecture White Paper has more details on system components.

Register a Harmony Account

You'll need a Harmony account to interact with a Harmony organization through the Harmony cloud. There are three ways to get one:

  1. Be invited by another Harmony user. Use the link provided within your welcome email to register your account.

  2. Be invited by another Harmony user in an organization using single sign-on. You will already be registered through your Identity Provider.

  3. Request a free trial at A Jitterbit sales representative will send you a welcome email with further instructions after approving your request. Use the link provided in that welcome email to complete the registration process.


    If someone in your company converts a trial to a full subscription, you should move your projects to it before your trial expires (see Cloud Studio Project Exports and Imports, Design Studio Export as a Jitterpak, and API Manager Export and Import APIs).

Log In to the Harmony Portal

Log in to Jitterbit's Harmony Portal at using your Harmony account credentials.

Once logged in, your currently selected Harmony organization is shown in the top right. You can use the menu to switch between organizations:

organization menu


By default, Harmony accounts are provisioned with a personal Data Loader organization whose name is the email address associated with your Harmony account. For Harmony subscribers, this Data Loader organization isn't relevant and shouldn't be used.

Administer Your Organization

Harmony organization administrators are users with a role having the Admin permission. Administrators can change an organization's configuration.

To get your organization ready for users, you can do any of the following:

Configure Organization Settings

You can define and manage organization policies and security settings from the Management Console Organizations page:

  1. In the Harmony Portal, go to Management Console > Organizations.
  2. In the table row for the selected organization, use the Action menu to select Edit Organization Policies.
  3. Review and configure the available settings, including password requirements, two-factor authentication, single sign-on, and other security details. Each option is described at Edit Organization Policies.

Install and Configure Privately Hosted Infrastructure

If you don't want to use Jitterbit's Cloud Agents, you can host your own Private Agents within your corporate firewall or virtual private cloud. (You can also host a Private API Gateway instead of using Jitterbit's Cloud API Gateway to process API traffic, but this is less common.)

If you choose to host components privately, these additional system requirements apply:

You may also need to add certain Jitterbit IP addresses to your firewall's allowlist.

To use Private Agents, create an Agent Group, then add and install agents in it:

Create an Agent Group

  1. In the Harmony Portal, go to Management Console > Agents > Agent Groups.
  2. In the top right of the page, click New Agent Group.
  3. Complete the configuration of the Agent Group. Each option is described at Add Agent Groups.
  4. The newly created Agent Group is now listed in the table.

Add Agents

  1. In the Harmony Portal, go to Management Console > Agents > Agents.
  2. In the top right of the page, click New Agent.
  3. Complete the configuration of the agent by providing a name and selecting the newly created Agent Group. Then click Save.
  4. The newly added agent is now listed in the table with a status of Unregistered. The agent will not be available for runtime processing until you install the agent software and associate the Agent Group to an environment.

Install Agents

  1. In the Harmony Portal, go to Downloads.
  2. Download the version of the agent for your system. (See Downloads.)
  3. Follow the instructions for your operating system:

  4. Once an agent is installed and running, its status in the Management Console > Agents > Agents page will be Running. The agents will not be available for runtime processing until you associate the Agent Group to an environment.

  5. To use a highly available and load-balanced Agent Group, repeat the agent installation process for all agents in the Agent Group.

Configure Environments

Most Harmony applications use environments to keep projects or APIs separate. New Harmony organizations automatically get an environment called Default Environment that is associated with Jitterbit's Production Cloud Agent Group.

If you are using Private Agents, you can change the Agent Group associated with the default environment to your newly created Private Agent Group.

You can also configure additional environments, such as Development, Test, or Production, according to your software development lifecycles and practices.

You can create and edit environments on the Management Console Environments page.

Change Agent Groups

  1. In the Harmony Portal, go to Management Console > Environments.
  2. On the far right of an existing environment row, use the Action menu to select Associate Group.
  3. Select the appropriate Agent Group and click Save.

Add an Environment

  1. In the Harmony Portal, go to Management Console > Environments.
  2. In the top right of the page, click Add New Environment.
  3. Complete the configuration of the environment. Each option is described in Add Environments.

Invite Team Members

Before a user can collaborate in your organization, they must be a member of a role that has permissions assigned at the organization level. To access and perform actions in a given environment, that role must also be granted access at the environment level:

  1. In the Harmony Portal, go to Management Console > Organizations.

    The top part of the page lists any Harmony organizations you belong to. The bottom part of the page has two tabs, Roles and Members:

    • Roles: A role defines a set of permissions that a role member has. The permissions grant access to different applications within the organization, and let the member perform certain actions within them. A user can be a member of one or more roles.

    • Members: Members are all the users of your organization that have roles within the organization.

  2. Select your organization in the top part of the page, then select the Roles tab on the bottom. Two roles are created by default: Administrator and User.

    1. Within a role's Action menu, select Add Member.

    2. Enter the email address of the user to add to the selected role, then click Save. You can also add new members from the Members tab with the Add Member button using the menu to select a role.

  3. The invited user receives an email with further instructions. Use the Members tab to check the status of members of your organization.

  4. To give organization members access to an environment, you must also define role access for the environment. To do this, follow these steps:

    1. Use the menu to go to Management Console > Environments.

    2. Select your environment in the top part of the page, then select the Roles tab on the bottom.

    3. For a given role, the current access levels for the environment are displayed under the Access column on the far right.

      • Grant Role Access: To grant environment access to an existing role, click Grant Role Access, select the appropriate access level, and click Save.

      • Edit Role Access: To edit access for an existing role, click the access level for each role to toggle access on and off.

Next Steps

To start designing an integration project, see the Cloud Studio Quick Start Guide.