Upgrade a Windows Private Agent¶

Introduction¶

Upgrading a Private Agent from an earlier Private Agent version to a later one usually can be done without uninstalling the prior agent version, as described in minor upgrades below.

However, there are several cases where a complete uninstall of the agent is required in order to upgrade. These are considered major upgrades and are described in more detail in the following sections:

• Upgrade from a 10.x Windows Private Agent to an 11.x Windows Private Agent
• Upgrade from a 32-bit to a 64-bit Windows Private Agents

Private Agents can also be rolled back to a previous version as described at the end of this page in Roll Back a Private Agent.

Minor Upgrade¶

For a minor upgrade, generally, you use the instructions for installing a Private Agent and follow the prompts to upgrade the existing agent installation.

A Private Agent takes a very short time to upgrade—on the order of three minutes—depending on the server. If having any outage is a concern, you can use high availability (two or more agents) and have no downtime. If your current subscription does not have additional agents available for this, contact your Customer Success Manager (CSM).

Follow these instructions for minor agent upgrades:

1. Back up the configuration files and security certificates for reference (optional; see Uninstall a Private Agent).

2. Check if you need to uninstall the agent first following the major upgrade instructions, based on the installed agent type and version:

   • If upgrading to a 64-bit version (located in C:\Program Files\Jitterbit Agent) from a 32-bit version (located in C:\Program Files (x86)\Jitterbit Agent).
   • If upgrading to an 11.x version from a 10.x version.

3. Install the new version of the agent (see Install a Private Agent).

4. To use the backup files (optional):

   1. Stop agent services (see Restart a Private Agent).

   2. Place your saved security certificates in the installation directory. Manually update the newly installed configuration files based on the settings in your saved files.

      Warning

      Directly copying over saved configuration files after an agent version change can cause errors. Instead, use tools like the Notepad++ Compare plugin to help you manually compare and update configuration settings. Do not change settings with defined passwords or ports such as those found in the credentials.txt file and under the [DbInfo] section of the jitterbit.conf file.

   3. Start agent services (see Restart a Private Agent).

Major Upgrade¶

This section describes the circumstances and instructions under which a complete uninstall of the existing Private Agent is requried in order to upgrade.

Upgrade from a 10.x Windows Private Agent to an 11.x Windows Private Agent¶

To upgrade from a 10.x to 11.x Windows Private Agent, follow these steps:

1. Back up the agent configuration files and security certificates for reference (optional, see Uninstall a Private Agent).
2. Uninstall the existing 10.x agent (see Uninstall a Private Agent).
3. Remove all Jitterbit-related files (see Uninstall a Private Agent).

4. In addition to uninstalling the agent, it is strongly recommended to uninstall the existing 9.6.x PostgreSQL database. If you don't want to uninstall the PostgreSQL database, it can remain installed but will be disabled when an 11.x Windows Private Agent is installed. In this case, see PostgreSQL 9.6 and 14.5 Parallel Installations below.

5. Install the 11.x version of the agent (see Install a Private Agent). On upgrading to an 11.x version of the agent, the PostgreSQL ODBC driver will be upgraded to PostgreSQL ODBC 13.2.0.0. All projects will be re-downloaded by the agent.

6. To use the agent configuration backup files (optional):

   1. Stop agent services (see Restart a Private Agent).

   2. Place your saved security certificates in the installation directory. Manually update the newly installed configuration files based on the settings in your saved files.

      Warning

      Directly copying over saved configuration files after an agent version change can cause errors. Instead, use tools like the Notepad++ Compare plugin to help you manually compare and update configuration settings. Do not change settings with defined passwords or ports such as those found in the credentials.txt file and under the [DbInfo] section of the jitterbit.conf file.

   3. Start agent services (see Restart a Private Agent).

PostgreSQL 9.6 and 14.5 Parallel Installations¶

When you install an 11.x Windows Private Agent, the installation will detect an existing PostgreSQL 9.6 installation from the registry and warn you that it will be disabled.

On acknowledging the warning, the existing 9.6 PostgreSQL database will be stopped, the PostgreSQL 9.6 Windows service will be disabled from running automatically, and the 14.5-1 version of PostgreSQL will be installed with the 11.x agent installation.

Upgrade from a 32-bit to a 64-bit Windows Private Agents¶

When upgrading from a 32-bit to a 64-bit Windows Private Agent, existing 32-bit agent versions must be uninstalled prior to upgrading (see instructions for Windows Uninstall).

In addition, existing PostgreSQL and PostgreSQL driver (psqlODBC or pODBC) installations must be uninstalled.

Existing 32-bit ODBC drivers are not supported on 64-bit Private Agents.

Roll Back a Private Agent¶

It is not expected to need to revert to a previous version of a Private Agent. However, should it be required, the steps are provided below for a minor downgrade and a major downgrade.

Minor Downgrade¶

Follow these steps to downgrade from an 11.x agent to an earlier 10.x agent, or from a 10.x agent to an earlier 10.x agent:

1. Back up the agent configuration files and security certificates for reference (optional, see Uninstall a Private Agent).
2. Uninstall the agent (see Uninstall a Private Agent).
3. Remove all Jitterbit-related files (see Uninstall a Private Agent).

4. Install the selected version of the agent (see Install a Private Agent).

5. To use the agent configuration backup files (optional):

   1. Stop agent services (see Restart a Private Agent).

   2. Place your saved security certificates in the installation directory. Manually update the newly installed configuration files based on the settings in your saved files.

      Warning

      Directly copying over saved configuration files after an agent version change can cause errors. Instead, use tools like the Notepad++ Compare plugin to help you manually compare and update configuration settings. Do not change settings with defined passwords or ports such as those found in the credentials.txt file and under the [DbInfo] section of the jitterbit.conf file.

   3. Start agent services (see Restart a Private Agent).

Major Downgrade¶

Follow these steps to downgrade from an 11.x Windows Private Agent to a 10.x Windows Private Agent:

1. Back up the agent configuration files and security certificates for reference (optional, see Uninstall a Private Agent).
2. Uninstall the agent (see Uninstall a Private Agent).
3. Remove all Jitterbit-related files (see Uninstall a Private Agent).

4. Uninstall the PostgreSQL 13.2.0.0 ODBC driver.

5. Uninstall the Microsoft Visual C++ driver.

6. Install PostgreSQL 9.6 prior to installing the 10.x agent. The PostgreSQL 9.6 installation can exist at the same time as the PostgreSQL 14.5 installation; there is no need to uninstall PostgreSQL 14.

7. Install the 10.x version of the agent (see Install a Private Agent). During the installation, the presence of PostgreSQL 9.6 will automatically be detected, and the installation process will direct you to perform an advanced installation.

8. To use the agent configuration backup files (optional):

   1. Stop agent services (see Restart a Private Agent).

   2. Place your saved security certificates in the installation directory. Manually update the newly installed configuration files based on the settings in your saved files.

      Warning

      Directly copying over saved configuration files after an agent version change can cause errors. Instead, use tools like the Notepad++ Compare plugin to help you manually compare and update configuration settings. Do not change settings with defined passwords or ports such as those found in the credentials.txt file and under the [DbInfo] section of the jitterbit.conf file.

   3. Start agent services (see Restart a Private Agent).