Jitterbit Success Central will be undergoing system maintenance and may be inaccessible during this time: November 5 at 11 to 3 pm PST; 5 November at 19:00 to 23:00 UTC; 6 November at 6 to 10 am AEDT.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Content Zone

Table of Contents
maxLevel3

The Agent Groups page of the Web 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 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.

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

Access the Agent Groups page from Menu > Agents > Agent Groups.

Image Modified

Info

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

Managing Agent Groups

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

View Agent Groups

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

Image Modified

There are two types of Agent Groups:

  • Jitterbit Cloud Agent Group: This group is already created within your Organization by default  The Cloud Agent Group is automatically scaled within the cloud as necessary, and does not require adding Agents to expand capacity.
  • Local Agent Group: This type of group allows you to group together your own customized, private Agents to run on-premise integrations. You will need to download and install the Agent software per Agent of the group.

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

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

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

Add Agent Groups

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

  • Name: Provide a name for your Local Agent Group, for example "Private Agent Group 1."
  • Description: Provide a description for your Local Agent Group.
  • Enable Cloud Logging: The Cloud Logging option determines if logged data will be temporarily saved and accessible from within the cloud. Check the box to enable Cloud Logging, or uncheck to disable. 
    • Enabled: The default is enabled, which allows logging of data 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 on the link displays the logging information in a separate popup window generated from the 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 Manager.

Edit or Remove Agent Groups

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

Image Modified

  • 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 Organization.
Info

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

View or Edit Jitterbit Conf

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

Image Modified

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

  • All Local Agents within the Local Agent Group are using Agents version 8.14 or higher.
  • Remote Agent configuration is enabled. You can enable remote Agent configuration from the Organizations page under Actions > Edit Organization Policies. For more detailed instructions see Organizations.

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 Modified

To make changes to the jitterbit.conf file, click the Edit or Add buttons in the top right. A confirmation message will appear with the following 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
NOTE: If you do not wish to store the contents of your 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 to to Editing the Configuration File - jitterbit.conf.

Click OK on the confirmation message to continue. Fields that you can make changes to now become available for you to edit. When you are done, choose one of the following:

  • Submit: Save your changes.
  • Reset: Reset the editable fields back to the most recent stored configuration file.
  • Reset to default: Restore all configuration fields back to default settings.
  • 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.

Managing Available Agents

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

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

View Available Agents

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

Image Modified

In this table, you can see information about each Local 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.

Add Agents or Download Agent Software

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

You should now see your new Local 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 software on the Local Agent.

Prior to downloading and installing Local Agents, please review the following:

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

Image Modified

For further instructions on downloading and installing Local Agents, see the following:

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

Edit or Remove Agents

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

Image Modified

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

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

Stop Agent or Download Agent Logs

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

Image Modified

  • Choose Drain Stop to stop the Local Agent. If you use this option, make sure you have access to the Local Agent if you would like to restart the Agent later. The Agent cannot be restarted remotely from the Web Management Console and must be done manually on the Local 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 from within a firewall. The Agent Groups and Agents do not automatically synchronize these with the cloud, as they typically include business data. By using your own storage devices, you can keep that data within a firewall or private cloud infrastructures.

    By default, an Agent Group will store logs for 1 to 14 days depending on the type of log. The Agent Group can be configured to clean up this data at other intervals using the CleanupRules defined in the Jitterbit Agent home installation directory.

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

Table of Contents
maxLevel3
minLevel2
indent20px

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

HideElements
metastrue

Last updated: 

Lastmodifieddate