Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

The Agent Groups page of the Web of the Management Console  (WMC) allows you to group  Jitterbit Agents (runtime servers) so that each Agent in the group behaves consistently with other Agents in the group.Agent Groups provide for high availability provision, configure, and manage where your integrations run. You can manage your own customized, Private Agent Groups (formerly known as Local Agent Groups) to run on-premises integrations, or you can use Cloud Agent Groups that are hosted and managed by Jitterbit. With multiple agents in a group, Agent Groups provide for high availability (active/active) and load balancing of integration operations across Agents within a group. Installing more than one  Agent in an  Agent Group automatically allows for high availability (active/active). Installing multiple Agents in an Agent Group also automatically allows for load balancing.

By default, a Cloud Agent Group will already be set up when an Organization is created. If you wish to use one or more Local Agent Groups, you will need to set these up for your Organization using the instructions on this page.

those agents.

Info
NOTE: When you create Local Agent Groups , you will also need to associate them must be associated with an Environmentenvironment. For more information, see Environments.

Access To access the Agent Groups page from Menu > Agents > Agent Groups. Image Removed , log in to the Jitterbit Harmony Portal, then click the orange hamburger menu in the top left:

Image Added

From the menu, hover over Management Console > Agents and select Agent Groups:

Image Added

Info

NOTE: Make sure you are accessing the desired Organizationorganization. In the top navigation bar, use the dropdown that appears to the right of between your name and to the left of the Help menu to toggle switch between Organizationsorganizations.

Anchor
managing-agent-groups
managing-agent-groups
Managing Agent Groups

Administrators of the Organization organization manage the Agent Groups for that Organizationorganization.

View Agent Groups

The top section of the Agent Groups page contains a table that shows all the Agent Groups for your Organization.  Image Removed organization:

Image Added

There are two types of Agent Groups:

  • Jitterbit Cloud Agent Group: This type of group is already created within your Organization organization by default.   The Cloud Agent Group is  These groups are automatically scaled within the cloud as necessary, and does do not require adding Agents agents to expand capacity. Local Agent Group: By default, two Cloud Agent Groups will already be set up: 
    • Jitterbit Production Cloud Agent Group: The Jitterbit Production Cloud Agent Group runs the production version of Jitterbit, as listed in the Description column, and is the most stable.
    • Jitterbit Sandbox Cloud Agent Group: The Jitterbit Sandbox Cloud Agent Group runs the upcoming version available for testing prior to release, as listed in the Description column. The Jitterbit Sandbox Cloud Agent Group was introduced in Harmony version 9.2.2. Learn more in the video below.

      HTML
      <iframe src="https://player.vimeo.com/video/282523486" width="480" height="270" webkitallowfullscreen mozallowfullscreen allowfullscreen frameborder="0"></iframe>
  • Private Agent Group: This type of group allows you to group together your own customized, private

    Agents

    agents to run on-

    premise

    premises integrations. You will need to download and install the

    Agent

    agent software per

    Agent

    agent of the group. Learn more about administering, configuring, and troubleshooting Private Agents under our Private Agents documentation.

    Info
    NOTE: Private Agents were formerly known as Local Agents.

Initially, you will see the two Jitterbit Cloud Agent GroupGroups, which is are set up by default. Note that there is only one Cloud Agent Group neededthese Agent Groups are managed by Jitterbit; you cannot add additional Cloud Agent Groups or Cloud Agents. There is also nothing available to edit within the Cloud Agent GroupGroups, as Cloud Logging will always be enabled (logs viewable from the Menu > the Activities page page). You  You can also sort the table by clicking on any of the column headers.

To add and edit Local Private Agent Groups, follow the instructions in the next sections.

Info
NOTE: At At least one Environment environment must be created and associated with the selected Agent Group before you will be able to run a project. See See Environments  for additional information.

Add Agent Groups

To add a new Local Private Agent group, click the  button. Fill out the prompt as follows:

  • Name:

    Provide

     Provide a name for your

    Local

    Private Agent Group, for example "Private Agent Group 1."

    Description: Provide
    Warning
    WARNING: These special characters are not allowed: < > # % { } | \ / ^ ~ [ ] ` ; , : ? @ = &.
  • Description: Provide a description for your Local Private Agent Group.
  • Enable Cloud Logging: The Cloud Logging cloud logging option determines if logged data will be temporarily saved and accessible from within the Harmony cloud. Check  Select the box checkbox to enable Cloud Loggingcloud logging, or uncheck clear the box to disable. 
    • Enabled: The default is enabled, which allows logging of data logs to display within the Messages section of the Activities page within the Web Management Console.Disabled: If Cloud Logging is disabled, logged data can only be viewed securely. When an operation is run, a link will display within the Messages section of the Activities page. Clicking be accessible via the Activities page directly from the Messages tab.
    • Disabled: Clear the checkbox to disable cloud logging. When cloud logging is disabled, a link will be displayed in the Messages tab that allows the logging information to be viewed from the agent itself. Clicking on the link displays the logging information in a separate popup window generated from the Agent agent running on a local machine located behind the organization's firewall.

Your new Agent Group should now appear in the table of Agent Groups.

Info
NOTE: You may be limited to the number of Agent Groups you can create based on your subscription plan. If you require more Agent Groups, please contact your Client Success your Customer Success Manager.

Edit or Remove Agent Groups

On the far right of each Local Private Agent Group row is an Action dropdown showing the actions you can take for each Local Private Agent Group. 

  • Choose Edit to edit the Name, Description, or option to Enable Cloud Logging that was set up when the Agent Group was added.
  • Choose Remove to remove the Agent Group from your Organizationorganization.
Info

NOTE: You cannot view or edit the Jitterbit configuration file for the Jitterbit Cloud Agent GroupGroups.

Anchor
view-or-edit-jitterbit-conf
view-or-edit-jitterbit-conf
View or Edit Jitterbit Conf

On the far right of each Local Private Agent Group row is an Action dropdown showing the actions you can take for each Local Private Agent Group.

The action Jitterbit Conf will be available only if the following these conditions are met:

  • All Local Private Agents within the Local Private Agent Group are using Agents version agents version 8.14 or higher.Remote Agent
  • At least one agent within the Private Agent Group must be in a "Running" state.
  • Remote agent configuration is enabled. You can enable remote Agent agent configuration from the Organizations page under Actions > Edit Organization Policies.
Warning

WARNING: When you enable remote agent configuration, the current agent configuration (excluding the local Postgres cache database information and local predefined global variables) will be read and stored in the cloud so that you can view and edit it remotely. Once you enable remote agent configuration, any changes you make manually to the local jitterbit.conf file located on the agent will not take effect.

If you wish to disable remote agent configuration and again be able to edit the local jitterbit.conf file manually, you can do so on the Organizations page under Actions > Edit > Organization Policies

. For more detailed instructions see Organizations.

by unchecking the “Enable remote Agent configuration” checkbox. However, note that you will lose the current remote agent configuration that was stored in the cloud. After agent services are restarted, your agent will read from the local jitterbit.conf file.

Info

NOTE: Viewing and editing the jitterbit.conf configuration file is available only at the Agent Group level, not at the agent level. This is because all individual Private Agent configuration files should be identical. In addition, note that you cannot view or edit the Jitterbit configuration file for the Jitterbit Cloud Agent Groups.

Choose Jitterbit Conf to view the current settings of the jitterbit.conf file in table format. There are two tabs available:

  • Config: This tab provides the configuration settings available in the jitterbit.conf file. The table shows each section of the configuration file, the key parameter, whether the parameter is enabled, its value, and a description if available. For additional information about what each setting does,  please refer to Editing the Configuration File - jitterbit.conf.
  • Db Drivers: This tab provides a list of database drivers, also included in the jitterbit.conf file. This list includes the settings for database characters.

Image Removed

Options available within each tab are explained as follows.

Config

Image Added

To make changes to the jitterbit.conf file, click the the Add or Edit or Add buttons in the top right. A confirmation message will appear with the following this notification:

If you click OK, current Agent configuration (excluding the local Postgres Cache Database information and local predefined global variables) will be read and stored in the cloud so that you can view and edit them remotely. Please make sure your company policy allows for this action and that there was no proprietary information stored in the configuration files prior to this. Click Cancel now, if you prefer to edit the configurations directly on the servers.

Note
NOTECAUTION: If you do not wish to store the contents of your the jitterbit.conf file in the cloud via the Web Management Console, but would still like to make changes to the configuration file, you can do so manually. Please refer Refer to  to  Editing the Configuration File - jitterbit.conf.

Click OK on the confirmation message to continue. Fields that you can

For Add, a popup will provide these options:

  • Section: Select from a list of existing sections in the config file.
  • Enabled: Check this box to enable the Key, or uncheck to disable the Key.
  • Key: Enter the parameter that you would like to add to the selected section of the config file. For a detailed list of possible keys and values see Editing the Configuration File - jitterbit.conf.
  • Value: Enter the value that you would like to set for the parameter entered above. For a detailed list of possible keys and values see Editing the Configuration File - jitterbit.conf.

When you are done, choose one of these options:

  • Save: Save your addition. A confirmation message will appear with the following notification:
    If you click OK, All the Agent group's Agent configuration will be overwritten and Agents needs to be restarted after the update - please make sure that this is an acceptable maintenance period, backup current configuration if needed, and make sure you can perform additional maintenance on the Agent servers, should it be required.

    All Jitterbit services must be restarted in order for the new configuration to take effect. For instructions on restarting services, see Restarting Jitterbit Services below.

  • Cancel: Close the Jitterbit Conf window without saving. No changes to the config file will be submitted.

For Edit, fields that you can make changes to now become available for you to edit. If the value shown in the Value column contains single or double quotes, you must provide the replacement value with the same format using single or double quotes. For a detailed list of possible keys and values see Editing the Configuration File - jitterbit.conf.

When you are done, choose one of the followingthese options:

  • Submit: Save your changes. A confirmation message will appear with this notification:
    If you click OK, All the Agent group's Agent configuration will be overwritten and Agents needs to be restarted after the update - please make sure that this is an acceptable maintenance period, backup current configuration if needed, and make sure you can perform additional maintenance on the Agent servers, should it be required.

    All Jitterbit services must be restarted in order for the new configuration to take effect. For instructions on restarting services, see Restarting Jitterbit Services below.

  • Reset: Reset the editable fields back to the most recent stored configuration file. This option does not submit changes to the config file, but simply resets the values in the edit screen to those currently being used.
  • Reset to default: Restore all configuration fields back to default settings. This option sets the configuration to the default configuration used as if an agent were being installed from scratch. A confirmation message will appear with this notification:
    If you click OK, All the Agent group's Agent configuration will be overwritten and Agents needs to be restarted after the update - please make sure that this is an acceptable maintenance period, backup current configuration if needed, and make sure you can perform additional maintenance on the Agent servers, should it be required.

    All Jitterbit services must be restarted in order for the new configuration to take effect. For instructions on restarting services, see Restarting Jitterbit Services below.

  • Cancel: Close the Jitterbit Conf window without saving.
Info

NOTE: Viewing and editing the jitterbit.conf configuration file is available only at the Agent Group level, not at the Agent level. This is because all individual Local Agent configuration files should be identical.

Info

NOTE: You cannot view or edit the Jitterbit configuration file for the Jitterbit Cloud Agent Group.

  • No changes to the config file will be submitted.

Db Drivers

Image Added

To make changes to the database driver portion of the jitterbit.conf file, click the Edit button in the top right. A confirmation message will appear with this notification:

If you click OK, current Agent configuration (excluding the local Postgres Cache Database information and local predefined global variables) will be read and stored in the cloud so that you can view and edit them remotely. Please make sure your company policy allows for this action and that there was no proprietary information stored in the configuration files prior to this. Click Cancel now, if you prefer to edit the configurations directly on the servers.

Note
CAUTION: If you do not wish to store the contents of the jitterbit.conf file in the cloud via the Management Console, but would still like to make changes to the configuration file, you can do so manually. Refer to to Editing the Configuration File - jitterbit.conf.

Click OK on the confirmation message to continue.

The contents then become editable, where you can modify entries as appropriate. When you are done, choose one of these options:

  • Submit: Save your changes. A confirmation message will appear with this notification:
    If you click OK, All the Agent group's Agent configuration will be overwritten and Agents needs to be restarted after the update - please make sure that this is an acceptable maintenance period, backup current configuration if needed, and make sure you can perform additional maintenance on the Agent servers, should it be required.

    All Jitterbit services must be restarted in order for the new configuration to take effect. For instructions on restarting services, see Restarting Jitterbit Services below.

  • Reset: Reset the database driver portion of the config file back to the most recent stored configuration file. This option does not submit changes to the config file, but simply resets the values in the edit screen to those currently being used.
  • Cancel: Close the Jitterbit Conf window without saving. No changes to the config file will be submitted.

Restarting Jitterbit Services

Multiexcerpt include
MultiExcerptNameRestart-Services
PageWithExcerptEditing the Configuration File - jitterbit.conf

Managing Available Agents

The Available Agents tab in the bottom portion of the page shows each Agent agent associated with a selected Agent Group.

  • Local Private Agent Groups: Shows the Local Private Agents within a Local Private Agent Group and the status of each Local Private Agent. 
  • Cloud Agent GroupGroups: Managed by Jitterbit. You are unable to manage Available Agents within this groupthese groups

View Available Agents

The bottom section of the Agent Groups page contains a tab for Available Agents. This table will display all Local Private Agents for the Local Private Agent Group selected in the top portion of the page.:

Image Removed Image Added

In this table, you can see information about each Local Private Agent including IP address, operating system, version, status, and available actions you can take. You can also sort this table by clicking on any of the column headers.

View Conflicts with the Jitterbit Config File

If you have remote agent configuration enabled (Organizations page under Actions > Edit Organization Policies) and there is a conflict between the remote agent configuration and local agent configuration file, you will see Image Added icons next to a Private Agent name.

Note that if remote agent configuration is enabled, then the remote agent configuration file overrides any settings in the local agent jitterbit.conf configuration file. Thus, these warnings are provided for your information only, and may be expected in circumstances such as when you have made changes to the configuration file remotely via this page (see View or Edit Jitterbit Conf above). 

  • Hover over the Image Added icon to see a short description of conflicting values.
  • Click on the Image Added icon to view the detailed description of any conflicting values.

    Image Added

Warning

WARNING: When you enable remote agent configuration, the current agent configuration (excluding the local Postgres cache database information and local predefined global variables) will be read and stored in the cloud so that you can view and edit it remotely. Once you enable remote agent configuration, any changes you make manually to the local jitterbit.conf file located on the agent will not take effect.

If you wish to disable remote agent configuration and again be able to edit the local jitterbit.conf file manually, you can do so on the Organizations page under Actions > Edit > Organization Policies by unchecking the “Enable remote Agent configuration” checkbox. However, note that you will lose the current remote agent configuration that was stored in the cloud. After agent services are restarted, your agent will read from the local jitterbit.conf file.

Add Agents or Download Agent Software

To add a new Local Private Agent to your selected Local Private Agent Group, click the  button. In the popup, enter a name for your new Agent.

You should now see your new Local Private Agent listed in the table of Available Agents. By default, it will have a status of "Unregistered" and will not be available for runtime processing until you download and install the Agent agent software on the Local Private Agent.

Prior to downloading and installing Local Private Agents, please review the followingthese pages:

To download the Agent agent software, use the Action dropdown on the far right and select the appropriate download option for your system.

For further instructions on downloading and installing Local Private Agents, see the followingthese pages:

Info
NOTE: You can also add Agents agents and download Agent agent software via the Agents > Agents page. If added from the Agents agents page, you will also need to select the Local Private Agent Group that you want to associate the new Local Private Agent with.
Info
NOTE: You may be limited to the number of Agents agents you can create based on your subscription plan. If you require more Agentsagents, please contact your Client Success your Customer Success Manager.

Edit or Remove Agents

To edit or remove Local Private Agents, use the Action dropdown on the far right. These options will be disabled if your Agent agent is currently in "Running" status. The Agent agent must be either "Stopped" or "Unregistered" in order to edit or remove the Agentagent.

Image Modified

  • Choose Edit to change the name of your Local Private Agent.
  • Choose Remove to delete the Local Private Agent from the Organizationorganization.

    Note
    NOTECAUTION: This will not only remove the association of the Local Private Agent with the Local Private Agent Group, but it will also remove the Local Private Agent from your Organizationorganization.

Stop Agent or Download Agent Logs

To stop the Local Private Agent or download Agent agent logs, use the Action dropdown on the far right. These options will be disabled if your Agent agent is currently in "Stopped" or "Unregistered" status. The Agent agent must be in "Running" status in order to stop the Agent agent or download Agent agent logs.

Image Modified

  • Choose Drain Stop to stop the Local Private Agent. If you use this option, make sure you have access to the Local Private Agent if you would like to restart the Agent agent later. The Agent agent cannot be restarted remotely from the Web Management Console and must be done manually on the Local Private Agent.
  • Choose Download Agent Log to open a prompt to select logs for detailed troubleshooting and auditing purposes. Check the logs you wish to download and click Submit to begin the download.

    Image Modified

    Info

    NOTE: These logs can either be accessed via the

    Web

    Management Console as shown above or can be

    stored on local file storage devices such as file shares or SFTP and accessed

    accessed on a Private Agent from within a firewall.

     

    The

    Agent Groups and Agents

    agents do not automatically synchronize

    these

    the logs with the cloud, as they typically include business data. By using

    your own storage devices

    a Private Agent, you can keep that data within a firewall or private cloud infrastructures.

    By default,

    an

    a Private Agent

    Group

    will store logs for 1 to 14 days depending on the type of log. The Private Agent

    Group

    can be configured to clean up this data at other

    intervals using the CleanupRules defined in the Jitterbit Agent home installation directory

    intervals by editing the rules in the Jitterbit.conf file within the [FileCleanup] and [ResultFiles] sections (see Editing the Configuration File). You can also change the number of days all of the files are saved by Editing the Jitterbit File Cleanup Service Rules for Private Agents.

Panel
borderColor#65379B
titleColor#FFFFFF
titleBGColor#65379B
titleOn This Page
Table of Content Zone

Table of Contents
maxLevel34
minLevel2
indent20px

Panel
borderColor#00B886#FF7C4C
titleColor#FFFFFF
titleBGColor#00B886#FF7C4C
titleRelated TopicsArticles
Content by Label
showLabelsfalse
max1000
showSpacefalse
sorttitle
cqllabel in ("wmc-overview","getting-started-overview","local-agent-overview") and space = "DOC"
Panel
borderColor#00B886
titleColor#FFFFFF
titleBGColor#00B886
titleRelated Topics

HideElements
metastrue

Last updated: 

Lastmodifieddate