Configuration files for Jitterbit private agents

Overview

When a private agent starts, it authenticates with Harmony and joins an agent group using the registration information provided during installation.

When a private agent is running, it uses these configuration files:

Of these, the key file is jitterbit.conf. You can edit this on the host, or remotely in the Management Console. (Only this file can be edited remotely. All others must be edited on the host.) When you have multiple agents in a group, remote editing is faster and easier, and ensures that all agents are configured the same way.

Remote configuration

Prerequisites

To remotely edit an agent group's configuration files, you must have a role with Admin permission for the organization your agent group belongs to.

Enable

To enable remote editing, follow these steps:

1. Select Management Console > Organizations.

2. Select the active organization in the table to open its Organization Policies pane.

3. In the Agent Management tab, enable Remote agent configuration.

Edit

All agents' statuses must be Running before you can remotely edit an agent group's configuration. When you do, Harmony keeps a master copy that it uses to overwrite the values in the jitterbit.conf files of all active agents in the group. (Only values are overwritten; comment lines are unaffected.)

To edit an agent group's configuration files remotely, follow these steps:

1. Select Management Console > Agents.

2. Click the Jitterbit configuration button for the agent group.

3. Click Edit configuration.

4. In the dialog that opens, read the information text, then click the Continue button.

5. Change values, or enable or disable settings, then click Submit.

6. Read another Confirmation Message dialog, then click OK to continue.

7. When the configuration is received by an agent, the following appears in the log/jitterbit-agent.log file:

   Jitterbit.conf file is modified on the disk. Please restart Agent services manually for the effect to take place
   

8. Restart the private agent:

   WindowsLinuxDocker

   From the Windows Start menu, select Jitterbit Agent > Stop Jitterbit Services, then Jitterbit Agent > Stop Jitterbit Services.

   jitterbit restart
   

   docker exec NAME jitterbit restart
   

   • NAME: the container name or ID.

   Important

   If the agent was started with environment variable AUTO_REGISTER_DEREGISTER_ON_DRAINSTOP=true, deregisterAgentOnDrainstop: true in register.json, or DeregisterAgentOnDrainstop=true in the AutoScaling section of jitterbit.conf, the agent restarts but won't re-register. In this case, open a shell on the container and perform initial configuration again. To do this, run jitterbit-config, respond to the prompts, then run jitterbit restart. The container's agent re-registers with Harmony with a different agent name.

Add

To add a key to the configuration, follow these steps:

1. Select Management Console > Agents.

2. Click the Jitterbit configuration button for the agent group.

3. Click Add configuration. In the dialog that opens, read the information text, then click the Continue button:

4. A new row appears in the table. Enter values for Section, Key, and Value, set the Enabled status on or off, then click Save:

5. Restart the agent.