Get started with Jitterbit Harmony

Overview

Jitterbit Harmony is a unified AI-infused low-code platform for integration, orchestration, automation, and app development. You can use Jitterbit Harmony 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 Jitterbit Harmony applications and components.

2. Register a Jitterbit Harmony account.

3. Log in to the Harmony portal at https://login.jitterbit.com and start using Jitterbit applications.

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

Applications and components

Jitterbit 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.

Jitterbit web-based applications are accessible through the Harmony portal. You can use the latest versions of Google Chrome, Microsoft Edge (Windows only), 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 an account to interact with a Jitterbit 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 jitterbit.com/harmony/trial. 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 within 30 days.

   Tip

   If someone in your company converts a trial to a full subscription and you have projects in a separate trial, you should move your projects to the full subscription before your trial expires (see Integration 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 the Harmony portal at https://login.jitterbit.com 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:

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.
• Install privately hosted infrastructure.
• Configure environments.
• Invite team members.

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. Select an organization in the table, or hover on one and click 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:

• System requirements for private agents
• System requirements for private API gateways

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

To use private agents, create an agent group and add agents, then install agents in it:

Create an agent group and add agents

1. In the Harmony portal, go to Management Console > Agents.
2. In the top right of the page, click Add Agent Group.
3. Complete the configuration of the agent group. Each option is described at Add an agent group.
4. Expand the agent group's details pane and add agents to it.
5. Each newly added agent has 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:

   • Windows: Windows private agent (most common) or Windows quiet private agent.
   • Linux: Debian private agent, RPM private agent, or Linux-based Docker private agent.

4. Once an agent is installed and running, its status in the Management Console > 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 the Jitterbit 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. Hover on an environment row and click the Edit icon in the Action column.
3. Use the Agent group associated menu to select the appropriate agent group.
4. Click Save.

Add an environment

1. In the Harmony portal, go to Management Console > Environments.
2. Click Add 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 > User Management.

   The page has these tabs:

   • Harmony Users: Users who have accepted invitations to join an organization. Access to Harmony is defined by the roles they are assigned, the permissions each role grants, and the access levels those roles have in different environments.

   • External Users: Users who have accepted invitations to access the API portal. External users don't have roles.

   • 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.

2. Select your organization in the top part of the page, then select the Harmony Users tab.

   1. Click Add Harmony user or Add user. A new row appears in the table.

   2. Enter the email address of the Harmony user. If the organization has SSO enabled, the email address must match that used with the SSO identity provider.

   3. Click the Roles menu to open it, then select one or more roles.

   4. Click Send invitation to send an email to the user.

3. The invited user receives an email with further instructions. Use the Harmony Users 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 table. The Role Access panel opens at the bottom of the page.

   3. For each role, the access levels for the environment are shown. Each access level can be enabled or disabled.

Next steps

To start designing an integration project, see the Integration Studio quick start guide.

See additional resources to publish an API, create an app, or manage EDI transactions.