Versions Compared

Key

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

Agent Groups Console 

...

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 Agent in the group behaves consistently with other agents Agents in the group. This provides The Agents within each group are set up separately on the Agents page.

Agent Groups provide for high availability and load balancing of integration operations across agents Agents within a group. Installing more than one agent in an agent group one Agent in an Agent Group automatically allows for high availability (active/active). Installing multiple agents Agents in an agent group Agent Group also automatically allows for load balancing.

Agent Groups are managed in the  Agent Groups Console. Use the Agent Groups Console to provision, configure and manage where your integrations run.

NOTE: The Agent Groups Console is available to members of the Administrator Role. Members of the User Role will not see this option in their menu.

  • Click Menu in the Main Menu bar.

Image Removed
 

  • The drop-down menu displays all available functions in the WMC.
  • Hover over Agent Groups  in the list on the left side of the drop-down menu.
  • Highlight and Click on Agent Groups in the right side of the drop-down menu.
  • The Agent Groups Console displays. 

Jitterbit Cloud Agent Group

Selecting the Jitterbit Cloud Agent Group as your Agent Group allows your organization to get started integrating without downloading and installing any local Agents.

  • Highlight Jitterbit Cloud Agent Group in the list of available Agent Groups.

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.

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

Image Added

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 Added

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.  There will not be any Available Agents listed in the lower half of the screen if you are using the Cloud Agent Group.

Cloud Logging

The Cloud Logging option determines if logging data will be temporarily saved and accessible from within the cloud. Cloud Logging will always be set to Enabled in the Jitterbit Cloud Agent Group.

  • 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).

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

The Agent Groups Console allows you to view all of the local Agents available to each local Agent Group and monitor the status of Agent Agents. Additionally, you are able to add new local Agent Groups or local Agents and make the necessary configuration changes from the Agent Groups Console.

  • Click Menu in the Main Menu bar.
  • The drop-down menu displays all available functions in the WMC.
  • Hover over Agent Groups  in the list on the left side of the drop-down menu.
  • Highlight and Click on Agent Groups in the right side of the drop-down menu.
  • The Agent Groups Console displays.

Image Removed
  

Agent Group Cloud Logging

The Cloud Logging option determines if logging To add a new Local Agent group, click the Image Added 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
    set to Enabled
    • enabled, which allows logging of data to display
    in
    • within the Messages section of the Activities page within the Web Management Console.
    • Disabled:
      If
    •  If Cloud Logging is
    set to Disabled
    • disabled,
    logging
    • logged data can only be viewed securely.
     When
    • When an operation is run
    in the Activities Console
    • , a link
    will display
    • will display within the Messages section of the Activities
    Console
    • page. Clicking on the link displays the logging information in a separate
    pop-up
    • popup window generated from the
    agent
    • Agent running on a local machine located behind the organization's firewall.

Adding a New Local Agent Group

  • Click on the New Agent Group  Image Removed button in the upper right corner of the screen.  
  • The Add Agent Group pop-up window displays.

Image Removed 

  • Name:
    • Type the appropriate Name in the text box to the right of Enter Name.
  • Add Description:
    • Type the appropriate Description in the text box to the right of Add Description.
  • Cloud Logging:
    • Enable: Click the checkbox to the right of Cloud Logging to allow logging data to be viewed from within the Web Management Console.
    • Disable:  Leave the checkbox to the right of Cloud Logging uncheckedto require secure logging.
  • Click the Save button to add the new agent group.  The new Local Agent Group will now display in the grid.
  • Click the Cancel button to close the pop-up window without adding the new agent group.

Making Changes to a Local Agent Group

  • Click on the Name of the Agent Group you want to make changes to. The row in the grid will be highlighted.
  • Click on Action to the far right on the selected row in the grid.
  • The available change options display in the drop-down menu.

Image Removed  

Edit a Local Agent Group

  • Click on the Name of the Agent Group you want to make changes to. The row in the grid will be highlighted.
  • Click on Action to the far right on the selected row in the grid.
  • Click on Edit in the drop-down menu.
  • The Edit Agent Group pop-up window displays.

Image Removed 

  • Name:
    • Type the appropriate Name in the text box to the right of Enter Name.
    • Click the Save button to save the changes.
    • Click the Cancel button to close the pop-up window without saving your entries.
  • Add Description:
    • Type the appropriate Description in the text box to the right of Add Description.
    • Click the Save button to save the changes.
    • Click the Cancel button to close the pop-up window without saving your entries.
  • Enable Agent Group Cloud Logging:
    • Enable: Click the checkbox to the right of Cloud Logging to allow logging data to be viewed from within the Web Management Console.
    • Disable: Leave the checkbox to the right of Cloud Logging unchecked to require secure logging.
  • Click the Save button to save the changes.
  • Click the Cancel button to close the pop-up window without saving your entries.

Remove a Local Agent Group

  • Click on the Name of the Agent Group you want to remove. The row in the grid will be highlighted.
  • Click on Action to the far right on the selected row in the grid.
  • Click on Remove in the drop-down menu.
  • The following confirmation message displays.

Image Removed 

  • Click the Yes button to remove the Agent Group. The Local Agent Group will disappear from the grid.
  • Click the No button to close the Confirmation Message pop-up without saving your entries.

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

Available Local Agents

The local agents currently available to an Agent Group display in the lower half of the screen.

  • In the upper half of the screen, Click on the Name of the Local Agent Group.
  • The existing local agents associated with the selected agent group will now display in the Available Agents section in the lower half of the screen.

Image Removed
  

Adding a New Local Agent

NOTE:  

...

  • 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.
  • In the upper half of the screen, Click on the Name of the Local Agent Group you want to add a new agent to.
  • The existing local agents associated with the selected agent group will now display in the Available Agents section in the lower half of the screen.
  • Click on the Add AgentImage Removed button to the right of Available Agents on the left side of the screen.
  • The Add Agent pop-up window displays.

Image Removed 

  • Name:
    • Type the appropriate Name in the text box to the right of Enter Name.
    • Click the Save button to save the new agent. The new agent will display in the Available Agents grid in the bottom half of the screen.
    • Click the Cancel button to close the pop-up window without adding the new agent.
  • Status Unregistered:
    • The status at the time a new Agent is added will always be Unregistered.
    • The status will remain unregistered, and the new agent will not be available for run-time processing, until the Windows or Linux Agent has been downloaded and installed.

Maximum Subscription Limit

  • The following error message will display if you have previously added the total number of agents allowed in your subscription. 
  • Click OK to close this window without adding the new agent.
  • Contact your Jitterbit Sales Representative to increase your subscription level.

Image Removed
  

Making Changes to a Local Agent 

  • Click on the Name of the Local Agent you want to change. The selected row in the grid will be highlighted.
  • Click on Action to the far right on the selected row in the bottom half of the grid.
  • The available change options display in the drop-down menu.

Image Removed
  

 Edit a Local Agent

  • Click on the Name of the Local Agent you want to change. The selected row in the grid will be highlighted.
  • Click on Action to the far right on the selected row in the bottom half of the grid.
  • Click on Edit in the drop-down menu.
  • The Edit Agent pop-up windows displays.

Image Removed
 

  • Name:
    • Type the appropriate Name in the text box to the right of Enter Name.
    • Click the Save button to save the changes.
    • Click the Cancel button to close the pop-up window without saving your entries.
  • Add Description:
    • Type the appropriate Description in the text box to the right of Add Description.
    • Click the Save button to save the changes.
    • Click the Cancel button to close the pop-up window without saving your entries.

Download Windows Agent or Download Linux Agent

NOTE:  

...

Jitterbit supports Windows, Linux RPM and Linux Debian operating systems for local run-time agents.

  • Click on the Name of the Local Agent in the Available Agents section in the lower half of the screen.
  • The line will be highlighted.
  • Click on Action to the far right on the selected Local Agent row.

Image Removed
 

  • Click on Download Windows Agent, Download Linux RPM Agent or Download Linux Debian Agent in the drop down list.
  • Click Save File.

NOTE: The agent executable can be downloaded once, stored locally and re-used to install any additional local agents as they are added.  

Download Agent Log

The agent generates multiple logs that are useful for detailed troubleshooting and auditing purposes. The logs can be downloaded from the WMC without having to access the agent directly.
 
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 Added

  • 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 Added

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 Added

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 Added

In this table, you can see information about each Local Agent including IP address, operating system, version, status, and available actions you can take.

Add or Download Agents

To add a new Local Agent to your selected Local Agent Group, click the Image Added 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 Added

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

Info
NOTE: You can also add Agents 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 Agent Groups, 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 Added

  • Choose Edit to change the name of your Local Agent.
  • Choose Remove to disassociate the Local Agent from the Local Agent Group.

    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. If you instead wish to associate the Local Agent with a different Agent Group, you can do so from the Agents page.

 

Stop Agent or Download Agent Logs

To stop the Local Agent or download the Agent log, 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 the Agent log.

Image Added

  • 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 Added

    Info
    NOTE: 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

...

  • Click on Action to the far right on the Local Agent  row in the lower half of the grid.
  • Click on Download Agent Log in the drop-down menu.
  • The following drop-down menu displays.

Image Removed 

  • Click on the appropriate checkboxes to the left of the log type in the list to select which logs to download.
  • Click the Cancel button to close the drop down list without downloading any logs.
  • Click the Submit button to start downloading the selected logs.

Remove a Local Agent

  • Click on the Name of the Local Agent you want to remove. The selected row in the grid will be highlighted.
  • Click on Action to the far right on the selected row in the lower half of the grid.
  • Click on Remove in the drop-down menu.
  • The following confirmation message will display.

Image Removed 

  • Click the Yes Button to remove the Agent. The Agent will immediately disappear from the Available Agents section in the lower half of the page.
  • Click the No Button to cancel the removal process and close the Confirmation Message window.

Related Articles:

 

 

  • using the CleanupRules defined in the Jitterbit Agent home installation directory.