Install a Windows Private Agent¶

Introduction¶

These are the instructions on downloading and installing the Harmony Private Agent on Windows. Prior to installation, we recommend reviewing Agent Groups High Availability and Load Balancing and Private Agents Best Practices Tech Talk.

For information on system requirements, see System Requirements for Windows Private Agents.

An alternative to using the standard Windows Private Agent installer is to configure and run a silent and unattended installation of a Private Agent. For more information, see Install a Windows Quiet Agent.

Download a Windows Private Agent¶

These instructions on downloading a Windows Private Agent assume you have already created an Agent Group and Private Agent(s) for your organization within the Management Console Agent Groups and Agents pages, respectively.

1. Log in to the Harmony Portal and go to Management Console > Agents > Agent Groups.

2. In the upper portion of the screen, select the Agent Group row. The lower half of the screen should now list the Available Agents within the selected Agent Group.

3. In the lower portion of the screen, select the agent row. Then click the Action dropdown on the far right and select Download for Windows EXE.

4. The Windows agent executable can be downloaded, stored locally, and reused as needed for any additional Private Agents as they are added.

Install a Private Agent¶

Installing more than one agent in an Agent Group automatically allows for high availability. Installing multiple agents in an Agent Group also automatically allows for load balancing. See Agent Groups High Availability and Load Balancing for additional information. Before installing, check that all software requirements and notices have been met.

On each agent within the Agent Group:

1. Run the downloaded Windows agent executable file, and follow the prompts.

2. At the Login Credentials prompt, enter your Harmony credentials (the email address and password you use to log in to https://login.jitterbit.com).

   Caution

   If your organization and account use single sign-on (SSO), your normal SSO credentials will not work. You must use Harmony credentials to install Private Agent(s). See Installing a Private Agent in Registering and Logging In Using Harmony SSO for more information.

3. Follow the prompts to select your organization, agent, etc. The available options are those you have already configured from the Management Console.

   Note

   You must be a member of an organization role that has either Admin or Agent-Install permissions. See Organizations and the section on Manage Permissions, Roles, and Members for more information.

4. At the Select Install Mode prompt, choose the mode depending on whether you want to install the PostgreSQL instance that is bundled with the agent or have an existing installation of PostgreSQL that you would like to use:

   • Quick Install (Recommended): Installs all components needed to run a Private Agent including a PostgreSQL agent database and driver. Use this option if you have never installed PostgreSQL or a Private Agent on this computer before, or if you have properly uninstalled all components following the instructions in Uninstall a Private Agent. More information about the PostgreSQL database that is bundled with the agent is provided in PostgreSQL Requirements in System Requirements for Private Agents.

     Note

     When you are prompted to set up your PostgreSQL password, note that the password must conform to your system's password policies regarding length and complexity.

   • Advanced: Installs a Private Agent and configures a Private Agent database to use an existing PostgreSQL installation. You will need to provide your PostgreSQL credentials. You may wish to use this option if you want to manage passwords separately within each application.

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

     • For 11.0 Windows 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, the existing PostgreSQL database must be version 9.6.x.

     An existing 14.x PostgreSQL database must be set to use MD5 password encryption:

     postgres=# set password_encryption TO 'md5';
     SET
     

5. After installation, the agent will attempt to start and establish a connection with Harmony. This process can take more than a minute to complete.

   Important

   Harmony Private Agents installed on Microsoft Azure servers require a reduced agent heartbeat interval.

   You can check the status of the agent in the Management Console Agents page. Once an agent starts, its status should be Running.

   Note

   In agent versions 10.61, 10.62, 10.63, and 11.1, the status will be Stopped until an agent's Agent Group is associated with an environment.