Skip to Content

System Requirements for Private Agents

Introduction

These system requirements apply to Harmony Private Agents. These requirements are also covered in the installation guides for Private Agents on Linux and Windows systems.

Operating System Considerations and Best Practices

Prior to installation, review Agent Groups High Availability and Load Balancing and these operating system considerations and best practices.

Operating System Considerations

When deciding whether to install a Private Agent on a Linux or Windows operating system, review these considerations:

  • Version: All of the Private Agents in a specific Agent Group should be installed on machines using the same operating system and the same operating system version.

  • APIs: Linux Agents can accept a higher API load (more requests per minute) than Windows Agents on identical machines when using APIs configured through API Manager.

  • Databases: Windows authentication with Microsoft SQL Server is supported only on Windows Private Agents.

  • File Shares: Server Message Block version 2 (SMBv2) using the File Share connector for Cloud Studio or Design Studio is supported only on Windows Private Agents.

  • Microsoft Dynamics: The Microsoft Dynamics connectors (such as the Microsoft Dynamics CRM connector for Cloud Studio and the Microsoft Dynamics AX, CRM, and GP connectors for Design Studio) require Windows Private Agents.

Best Practices

We recommend following these best practices:

  • Supported systems: Install the Private Agent on a tested and supported system as listed on this page. For optimal results, we recommend you follow these prerequisites and requirements for the operating system, PostgreSQL database, and hardware.

  • High availability and load balancing: Prior to installation, review the recommendations for high availability (active/active) and load balancing as described in Agent Groups High Availability and Load Balancing.

  • Server installation: For production environments, we recommend installing the Private Agent on a server. Agent installation on a desktop machine is recommended only for development, quality control, or testing environments.

  • Clean installation: Do not install the Private Agent on a server that is already running another database. The agent installs and runs its own PostgreSQL database. Running the agent on a server that is already running an Oracle or SQL Server database may cause performance issues.

  • Same timezone: We recommend that all agents in a Private Agent Group have the same timezone. Because the timezone of configured schedules is dependent upon the Private Agent timezone, schedule runs may be unpredictable if the timezones are different.

  • Account permissions: We recommend using a Linux superuser or Windows local Administrator account for installing the agent. Using a local user account is not recommended.

  • Uninstalling: Before uninstalling, we recommend you copy the config files and security certificates of your current installation in the event you want to reinstall with the same configuration at a later time.

Operating System Requirements

Jitterbit requires that operating systems used for Harmony Private Agents meet these specifications:

Linux

The Linux version of the Harmony Private Agent requires a 64-bit OS. These are the supported distributions derived from Debian Linux and Red Hat Enterprise Linux for Intel hardware:

The Harmony Private Agent has not been certified against other similar distributions with Debian or RPM package distributions derived from the Debian and Red Hat distributions. Amazon Linux provides multiple Linux versions, of which only Amazon Linux AMI 2 has been certified.

Windows

The Windows version of the Harmony Private Agent requires a 64-bit OS and is supported for these versions:

  • Windows 10

  • Windows 11

  • Windows Server 2019

  • Windows Server 2022

Note

Jitterbit does not test against or support software versions no longer supported by Microsoft.

Note

As of Harmony release 10.34, 32-bit Private Agents are no longer available for download. If you are currently using a 32-bit agent, upgrade to a 64-bit agent following the instructions for Windows or Linux.

Prerequisite Software Requirements

Required Java Version

The Harmony Private Agent package is bundled with a 64-bit version of the Java 8 Runtime Environment (JRE) and does not require a separate Java runtime. Jitterbit automatically installs the required Java Runtime Environment specifically for Jitterbit to use so that it does not conflict with other Java installations that may already be installed. As of Harmony 9.8, the version of Java shipped with the Agent is the AdoptOpenJDK JRE. This JRE is licensed as described at the OpenJDK website.

Unlimited Strength Java Cryptography Extension Requirement

For the agent to securely communicate with resources such as servers, the Java Runtime Environment used by the agent should be using the Java Cryptography Extension (JCE) with Unlimited Strength Jurisdiction Policy Files. If you are using the JRE that is shipped with the agent, it is using JCE with Unlimited Strength Jurisdiction Policy Files.

If you substitute a different JRE for the one shipped with the agent, you will need to replace the policy files included with the JRE with Unlimited Strength Jurisdiction Policy Files, if it is not already using them. To install the Java Cryptography Extension Unlimited Strength Jurisdiction Policy Files:

  1. Go to the Oracle website to download the ZIP file containing Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files.
  2. Unpack the ZIP to extract the local_policy.jar and US_export_policy.jar JAR files.
  3. Copy and replace the existing JAR files found in <JITTERBIT_HOME>\jre\lib\security, replacing <JITTERBIT_HOME> with the path to your Private Agent root directory.
  4. Restart the Jitterbit Private Agent.

Linux

Linux prerequisites are detailed in Installing a Harmony Linux Agent. In summary, these are required for Private Agent installation on a Linux system:

Windows

The Windows version of the Harmony Private Agent has these requirements:

  • Windows updates: Install all Windows security and "critical" updates prior to installing or upgrading Harmony Private Agents. There are known Microsoft issues when installing on systems that don't have the latest updates (such as KB2966870 and KB3140245).

  • .NET: Microsoft .NET Framework 4.5 or above may be required.

  • NTFS: The install partition must be NTFS-formatted.

  • Compression: Do not use Windows compression on the Jitterbit folder, PostgreSQL folder, or temp folder on the machine where the Jitterbit Private Agent is installed and running. Using Windows compression will drastically slow down processing of Jitterbit operations and transformations.

PostgreSQL Requirements

PostgreSQL is installed as part of the Private Agent installation. This instance of PostgreSQL is for use only with and by Jitterbit.

The version of PostgreSQL distributed with the agent depends on the Private Agent version:

  • Private Agents 11.0 and later are bundled with the 64-bit, 14.5-1 version of PostgreSQL and the PostgreSQL 13.2.0.0 ODBC driver. Jitterbit Windows services for 11.x Windows Private Agents are dependent on the PostgreSQL 14 Windows service.
  • Windows Private Agents 10.x and Linux Private Agents 10.37 through 10.x are bundled with a 64-bit, 9.6.x version of PostgreSQL with the PostgreSQL 9.2 ODBC driver. Jitterbit Windows services for 10.x Windows Private Agents are dependent on the PostgreSQL 9.6 Windows service.

Using an existing PostgreSQL installation instead of the PostgreSQL instance bundled with the agent is supported through advanced configuration options:

The version of the existing PostgreSQL database must match that expected by the agent version:

  • For 11.0 Private Agents and later, an existing PostgreSQL database that is version 14.5-1 has been confirmed to work. Other 14.x PostgreSQL versions are expected to work but have not been tested.

  • For 10.x Windows Private Agents and 10.x Linux Private Agents that are at least 10.37, the existing PostgreSQL database must be version 9.6.x.

Important

Upgrading from a 10.x Windows Private Agent to an 11.x Windows Private Agent requires a complete uninstall. See the Windows upgrade instructions for additional information. Linux Private Agents can be upgraded from any 10.x agent version.

These requirements must be met to install the PostgreSQL instance that is bundled with the agent:

  • Do not install PostgreSQL separately prior to installing a Private Agent. (Private Agent upgrades do not upgrade an existing PostgreSQL installation to this version; they are left as-is.)
  • Do not use a plus sign (+) as part of the PostgreSQL password when installing a Harmony Private Agent. The minimum number of characters for a PostgreSQL password is eight (8). We recommend that you not use accented characters (such as é) or any of these characters in the PostgreSQL password: + @ $ % & [] {} () , ; ? ^ = £.
  • Do not have any other databases configured or running on the Jitterbit PostgreSQL instance.
  • Do not use the Jitterbit PostgreSQL database/server as part of any Jitterbit operations and transformations.
  • Do not use Windows compression on the Jitterbit folder, PostgreSQL folder, or temp folder on the machine where the Private Agent is installed and running. Using Windows compression will drastically slow down processing of Jitterbit operations and transformations.
  • Port 5432 on Windows Private Agents or port 46914 on Linux Private Agents must be free for use by the PostgreSQL database.
  • PgBouncer may be required for high-load environments. Harmony Linux Private Agent version 10.6 and later and Harmony Windows Agent versions 8.21 and later automatically install PgBouncer. If you already have an existing installation of PgBouncer and experience issues upgrading, contact support for assistance.

Hardware Requirements

These are the minimum requirements for hardware and virtual machines for Harmony Private Agents:

  • Quad-core processor

  • 8 GB RAM

  • 50 GB available hard drive space; this includes space for the software, parallel processing, and temporary storage that can grow quite large while running an operation

  • Minimum of 100 MB/s (megabytes per second) transfer rate on the hard drive

  • High-speed Internet connection

  • A direct hardware installation or an installation on a virtual machine from VMWare, VirtualBox, Amazon AWS, or Rackspace that is configured for the specific requirements outlined above

  • Optimal configuration of the system and overall environment; if not optimally configured, sporadic and unpredictable problems can result from poor disk IO, limited/out of memory, limited/out of disk space, power failures, and/or abrupt system restarts

  • Access to outbound port 443 (HTTPS) to communicate with Harmony. Port 443 is normally allowed by corporate server firewalls.

  • Access to specified inbound ports as needed; generally, inbound ports do not need to be opened

It is recommended that the Jitterbit API platform be used for inbound messages or data. Where a Private Agent is used to receive a message directly (such as an outbound message from Salesforce) in lieu of the Jitterbit API platform, then the inbound ports 443 (with SSL) or 46909 (HTTPS) could be opened. Custom ports may be used for specific requirements if they are redefined in the Private Agent configuration and are allowed by any corporate firewall.