Skip to Content

Harmony Microsoft Dynamics AX Agent Configuration


A Microsoft Dynamics AX connection requires the use of a Harmony Windows Private Agent with a Jitterbit Microsoft Dynamics AX REST Connector. These two pieces of software must be downloaded, installed, and configured prior to the use and configuration of the Cloud Studio Microsoft Dynamics AX Connector.


The Jitterbit Microsoft Dynamics AX REST Connector is an additional component, separate from the Harmony Cloud Studio Microsoft Dynamics AX Connector. The REST connector must be downloaded from the Harmony Portal Downloads page and installed on the same server as the agent. The Cloud Studio Microsoft Dynamics AX Connector will be automatically installed on the agent as required by Cloud Studio.


These are the prerequisites for the Jitterbit Microsoft Dynamics AX 4.0, 2009, and 2012 AX REST Connectors:

Installing and Configuring an Agent and Jitterbit AX REST Connector

Follow these steps to install and configure the agent and Jitterbit AX REST connector:

Step 1: Install a Harmony Windows Private Agent

Instructions on installing a Harmony Windows Private Agent are detailed on Installing a Harmony Windows Agent.

Once you have the Private Agent installed and it appears in the Harmony Management Console Agents page as Running, proceed to installing the appropriate Jitterbit AX REST connector.

Step 2: Install a Jitterbit AX REST Connector

Different versions of the Jitterbit Microsodt Dynamics AX REST Connector are available for download, depending on the version of Microsoft Dynamics AX you are connecting to. All Jitterbit AX REST connectors are available from the Jitterbit Harmony Downloads page and are listed under Connectors:

Harmony Downloads

Choose the Jitterbit Microsoft Dynamics AX REST connector based on the Microsoft Dynamics AX version you are connecting to:

Microsoft Dynamics AX Server Compatible Jitterbit AX REST Connector
Microsoft Dynamics AX 4.0 Microsoft Dynamics AX 4.0
Microsoft Dynamics AX 2009 Microsoft Dynamics AX 2009
Microsoft Dynamics AX 2012 Microsoft Dynamics AX 2012

From the Downloads page, download and install the appropriate connector, following the instructions given by the installer. The installer must be run on the same server where the Windows Private Agent is installed and running.

If you have multiple Private Agents in an Agent Group, repeat these installation steps for each agent in the Agent Group.


Only one service can be run on an agent at a time. All agents in the Agent Group need to be running the same version of the service.


As the REST connector service is installed by a different installer than the regular Harmony Agent installer, this service is not uninstalled when an agent is removed or uninstalled. Instead, follow the regular Windows steps to remove a program to remove the REST connector service if uninstalling an agent from a server.

After you have installed the appropriate Jitterbit Microsoft Dynamics AX REST Connector, follow these steps:

  1. Open a Command Prompt window, run ping, and retain the IP address.

  2. Navigate to C:\Windows\System32\drivers\etc\hosts and add an entry with the retained IP address followed by a unique string, for example jbexample. Retain the string, as this will be used during connection configuration for the Cloud Studio Microsoft Dynamics AX connector.


    The unique string should not contain any special characters. Including special characters will result in a connection error during connection configuration.

Step 3: Test the Agent and Connector Windows Service Configuration

In the Windows OS Services console (services.msc), check that the Jitterbit Microsoft Dynamics (AX 4.0, AX 2009, or 2012) REST Connector Service is installed and running. If it is not running, start it and set it to automatic start mode.

Check http://localhost:8002/AX/help in a browser. This will show you the operations available in the connector service. If you do not see the list of operations, this usually indicates that the Windows service hosting the connector has not started.

Harmony Downloads


Check that the agent can reach your Microsoft Dynamics AX instance by logging in to the Microsoft Dynamics AX instance from the agent.


To debug issues with a Jitterbit Microsoft Dynamics AX REST connector, set EnableWCFMessageTracing to true in the REST connector's configuration file. The configuration file for the Microsoft Dynamics AX 2012 REST connector can be found in this location:

C:\Program Files\Jitterbit\Jitterbit Dynamics AX 2012 Connector REST Service\Jitterbit.Connectors.Dynamics.AX2012.Host.exe.config


The names of the directories will vary depending on the REST connector being used.