Agents page in Jitterbit Management Console

Introduction

On the Agents page, you can manage private agents and private agent groups, and see information about cloud agents and cloud agent groups:

To open it, select Management Console > Agents from the Harmony portal menu:

On the Private tab, you can do the following:

• Manage [private agent(/agent/#private-agents) groups and the agents in them. (Your subscription plan determines how many of each you can have.)

• Manage a private agent group's [plugins(/management-console/plugins/).

• See which [environments(/management-console/environments/) each private agent group is associated with.

The Cloud tab shows the available [cloud agent groups(/agent/#cloud-agent-groups), and provides a link to Jitterbit's system status page:

Private agent groups

The Private tab shows available agent groups (Agent Group A and Agent Group B in this example):

In the top right is the Refresh icon. Click this to refresh the screen.

Under the tab selector is a toolbar with the following:

• Search: To search for agents or groups, enter a keyword in the Search field.

• Add Agent Group: Click the button to add an agent group.

Agent groups are represented as horizontal bars, each with the following:

• Open: Expand the group's details. When expanded, use the Close icon to hide the details.

• The agent group's name (which you can edit in place), and the group ID in parentheses.

• If there are environments associated with the group, they appear after the Environments: label.

• Cloud logging enabled: When on, you can access detailed log messages on the Messages tab of the Management Console [Runtime Operations(/management-console/runtime-operations/), and download agent logs. When off, the same tab provides a link to the operation log details on the agent host. If your firewall permits, the log opens in a separate browser tab. If you change this setting, you must restart all private agents in the group.

  Important

  This setting does not do the following:

  • Enable or disable operation logging. The setting affects only whether operation logs and detailed log messages are stored in the Harmony cloud.
  • Affect whether component input and output data (generated when operation debug logging is enabled) is stored in the Harmony cloud.

• Update connectors: Update Integration Studio Connector SDK-based [connectors][is connectors] on all agents in the group. This overrides the Disable Auto Connector Update [organization policy(/management-console/organizations/#edit-organization-policies) setting that inhibits automatic updates.

• Jitterbit configuration: Open the configuration drawer to view or edit the agent group's configuration parameters.

• Delete: Delete the agent group (possible only when all environments are disassociated).

View a private agent group's details

The details pane contains the group's description, and in a tab bar above the table, the Agents, Plugins, and Environments tabs, with numbers indicating how many items are in each:

The Agents tab shows the group's member agents (Agent 1 and Agent 2 in this example).

When the details pane is open, you can do the following:

• Sort tables: Click a column heading. Each subsequent click reverses the sort order as indicated by an arrow.

• Arrange columns: Click the View columns icon to open a Columns drawer in which you can change the arrangement and visibility of columns. To resize a column, grab and move the vertical bar that separates columns.

• Edit name and description: To edit the description, click on it, change it, then press Enter. You can edit the group name in the same way, in both open and closed views. (The description can be edited only when the group details pane is open.)

  You can use only alpha-numeric characters, underscores _, parentheses (), dashes -, and spaces in agent group names and descriptions, and agent names.

Add a private agent group

To add a private agent group, click the Add Agent Group button, enter a name and optional description, set Cloud logging on or off, then click the Save button:

When the new group appears (Agent Group C in this example), you can expand the group details pane and add agents to it:

Add agents to a private agent group

To add an agent, click the Add Agent icon on the right of the tab bar (to the right of the View columns icon):

Enter a name for the agent (Agent X in this example), then click the Save icon:

To do other things with an agent, hover on one and use the icons in the Actions column:

• Download agent logs: Open the menu, select which private agent logs to download, then click the Download button. You can select any or all of the following:

  • Jitterbit logs: All files in the private agent's JITTERBIT_HOME/log directory.

  • Apache logs: All files in the private agent's JITTERBIT_HOME/apache/log directory.

  • Transformation logs: All directories and files in the private agent's JITTERBIT_HOME/DataInterchange/Temp/LOG directory.

  • Tomcat logs: All files in the private agent's JITTERBIT_HOME/tomcat/logs directory.

  • Debug logs: All directories and files in the private agent's JITTERBIT_HOME/DataInterchange/Temp/Debug directory.

  Individual logs are zipped, combined, zipped again, then downloaded with the filename log.zip.

• Download Jitterbit Agent: Download the private agent software. Select the version and operating system, then click the Download button.

• Drain stop: Active only when the agent is running. A dialog opens for you to confirm the action.

• More actions: Click to reveal the following options:

  • Edit: Edit the agent's name. Active only when the agent is stopped or unregistered.

  • Delete: Delete the agent, removing it from the agent group and your organization. To confirm the action, enter the word DELETE in the Delete Agent dialog's text field, then click the Delete button. You can delete an agent when it is any of the following statuses: Starting, Stopped, Unregistered, Unknown.

Agent status

The Status column shows the agent's state, which can be one of the following:

• Unregistered: Agent added but not ready to execute operations.

• Starting: Agent is registered, and becoming ready to execute operations.

• Running: Agent is ready to execute operations.

• Stopping: Agent is responding to a [drain stop(/agent/private-agents/private-agent-installation/linux-agent-installation/restart-a-linux-agent/#restartingalinuxprivateagent-restart-agent) request. Running operations are allowed up to 120 seconds in which to finish before they are canceled.

• Stopped: Agent remains registered but does not execute operations.

• Unknown: Agent is registered but there was no heartbeat within the last 5 minutes (the default interval).

The following diagram shows how an agent's status can change:

stateDiagram-v2
  direction LR

  state "     Unknown\n(Lost heartbeat)" as U
  Unregistered --> Starting
  state Registered {
    Stopped --> Starting
    Starting --> Running
    Running --> Stopping: \nDrain stop
    Stopping --> Stopped

    Starting --> U
    Running --> U
    Stopping --> U
    Stopped --> U
  }

Manage an agent group's plugins

The Plugins tab shows the [plugins(/agent/plugins/) available to any agent in the group:

Use the toggle in the Association column to associate or disassociate plugins with the group.

To open the Management Console [Plugins(/management-console/plugins/) page for a plugin, hover on the Actions column, then click Go to plugin.

View an agent group's environment association

The Environments tab shows the organization's environments, and which are associated to the selected agent group:

To go directly to the Management Console [Environments(/management-console/environments/) page for an environment (where you can change the association status), hover on the Actions column, then click Go to environment.

Edit an agent group's Jitterbit configuration

You can see and edit the configuration for all agents in group without logging into individual agent hosts. To do this, there must be at least one agent in the group that has a Running status, and you must enable remote agent configuration the Agent Management tab of the [Organizations(/management-console/organizations/) page. When these conditions are met, an agent group's Jitterbit configuration button becomes active. Click it to open the Jitterbit Configuration drawer. The drawer contains two tabs, Configuration and Database Drivers:

To close the drawer, click Close in the top right corner.

Configuration

This tab reproduces the default private agent [jitterbit.conf(/agent/jitterbit-conf/) file in tabular form:

Between the tab bar and the table is a bar with the following controls:

• Search: Search for configuration items.

• Reset to default: Reset the configuration to the default settings.

• Edit configuration: Edit configuration items.

• Add configuration: Add configuration items.

To resize a column, grab and move the vertical bar that separates columns.

To sort the table, click a column heading. Each subsequent click reverses the sort order as indicated by an arrow.

Search

To find configuration items, enter a keyword in the Search field. The table is filtered to show items that match the highlighted keyword on any column:

Reset

To reset the configuration for all agents in the group to their default values, click Reset to default. In the dialog that opens, read the information text, enter the word RESET in the text field, then click the Reset button:

Edit

To edit the configuration for all agents in the group, click Edit configuration. In the dialog that opens, read the information text, then click the Continue button:

Add

To add an entry to the configuration for all agents in the group, click Add configuration. In the dialog that opens, read the information text, then click the Continue button:

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

Configuration conflicts

A symbol after the agent name means there is a conflict between the private agent's local configuration and the cloud version. To see the details of the conflict, click the icon. In the warning message that opens, click to copy the message, and Close to close it:

Database Drivers

This shows the database drivers section of the jitterbit.conf file:

To edit the database driver configuration for all agents in the group, click Edit. In the dialog that opens, read the information text, then click the Continue button:

Edit the file, then click Save to save, or Cancel to cancel:

In the dialog that opens, read the information text, then click the Save button:

Cloud agent groups

On this tab, you can see the Jitterbit [cloud agent groups(/agent/#cloud-agent-groups) and their versions:

To open the details for each cloud agent group, click the Open icon. When expanded, use the Close icon to hide the details.

To see the status of an agent group on https://trust.jitterbit.com/, click the Jitterbit System Status link.