Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Agent Groups Console 

Agent Groups allow users to group Jitterbit Agents (run-time servers) so that each agent in the group behaves consistently with other agents in the group. This provides 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.

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.


 

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

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

Managing Local 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.


  

Agent Group Cloud Logging

The Cloud Logging option determines if logging data will be temporarily saved and accessible from within the cloud.

  • Enabled: The default is set to Enabled, which allows logging data to display in the Messages section of the Activities Console.
  • Disabled:  If Cloud Logging is set to Disabled, logging data can only be viewed securely.  When an operation is run in the Activities Console, a link will display within the Messages section of the Activities Console. Clicking on the link displays the logging information in a separate pop-up window generated from the agent running on a local machine located behind the organization's firewall.

Adding a New Local Agent Group

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

 

  • 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:
    • EnableClick 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.

  

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.

 

  • 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:
    • EnableClick 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.

 

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


  

Adding a New Local Agent

NOTE:  Please review the Local Agent System Requirements prior to adding a new local agent. 

NOTE: Please review Agent Groups: High Availability and Load Balancing prior to adding a new local agent.

  • 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 Agent button to the right of Available Agents on the left side of the screen.
  • The Add Agent pop-up window displays.

 

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


  

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.


  

 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.


 

  • 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:  Please review the Local Agent System Requirements prior to downloading the agent. 

NOTE: Please review Agent Groups: High Availability and Load Balancing prior to downloading the agent.

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.


 

  • 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.
 
By default, an Agent Group will store logs for 1 to 14 days. The Agent Group can be configured to cleanup 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.

 

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

 

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

 

 

  • No labels