Skip to end of metadata
Go to start of metadata

Introduction

The Agents page of the Management Console allows you the option to set up Private Agents (formerly known as Local Agents) as on-premises runtime servers that execute your integration operations. All agents in an Agent Group will be synchronized the same way so that they execute operations consistently.

NOTE: When you create Private Agents, you will also need to associate them with a Private Agent Group. For more information, see Agents > Agent Groups.

To access the Agents page, log in to the Jitterbit Harmony Portal, then click the orange hamburger menu in the top left:

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

NOTE: Make sure you are accessing the desired organization. In the top navigation bar, use the dropdown that appears between your name and Help to switch between organizations.

Managing Agents

Administrators of the organization manage the agents for that organization.

View Agents

The top section of the Agents page contains a table that shows all of the Private Agents within the organization.

NOTE: Private Agents were formerly known as Local Agents.

In this table, you can see information about each 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  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 the Agents > Agent Groups page.

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

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 Private Agent, click the  button. In the popup, enter a name for your new agent, and use the dropdown to select an existing Private Agent Group you would like to associate with your new Private Agent.

WARNING: These special characters are not allowed: < > # % { } | \ / ^ ~ [ ] ` ; , : ? @ = &.

If you do not yet have an existing Private Agent Group you would like to associate, you can click the button  to open a new prompt where you can enter a name for your new Agent Group, an optional description, and choose whether to enable Cloud Logging. For more information about this option, see Agents > Agent Groups.

You should now see your new Private Agent listed in the table of 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 Private Agent.

Prior to downloading and installing Private Agents, please review these pages:

To download the 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 Private Agents, see these pages:

NOTE: You can also add agents and download agent software via the Agents > Agent Groups page.
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 Customer Success Manager.

Edit or Remove Agents

To edit or remove Private 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.

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

Stop Agent or Download Agent Logs

To stop the Private 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.

  • Choose Drain Stop to stop the Private Agent. If you use this option, make sure you have access to the Private Agent if you would like to restart the agent later. The agent cannot be restarted remotely from the Management Console and must be done manually on the Private Agent.

    NOTE: When an agent drain stop is initiated, the agent will now wait 180 seconds for any APIs to finish running before the drain stop is completed. For Private Agents, the wait time can be configured within the jitterbit-agent-config.properties file by setting agent.drainstop.api.wait equal to the desired number of seconds.

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

    NOTE: These logs can either be accessed via the 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. See Cleaning Up Drive Space.

Viewing Installed Plugins

Plugins are available to any agent within the Agent Group. This is in order to synchronize all plugins across an Agent Group. For more information on Jitterbit-provided plugins or to add custom plugins, see Customizations > Plug-ins

View Plugins

The bottom section of the Agents page contains a tab for Installed Plug-ins. This table displays all plugins for the Private Agent selected in the top portion of the page:

In this table, you can see a description of the plugin, the author, version, type, and available actions you can take. You can also sort this table by clicking on any of the column headers.

View Manifest Files

To view the manifest file associated with a particular plugin, use the Action dropdown on the far right:

The XML file should display or download.

<JitterbitPlugin SpecVersion="1.0">
<PipelinePlugin SpecVersion="1.0">
<Name>
http://www.jitterbit.com/plugins/pipeline/user/RunCommand
</Name>
<Version>1.0.0</Version>
<DisplayName>Jitterbit - Run Command</DisplayName>
<Author>Jitterbit, Inc.</Author>
<Description>Runs a command with optional arguments.</Description>
<UpdateUrl>NA</UpdateUrl>
<DocumentationUrl>NA</DocumentationUrl>
<!--
 Set the variable $Command with the command you want to run 
-->
<Command>[Command]</Command>
<!--
 Set the variable $Arguments with the arguments to your command. Set it to an empty string if the command takes no arguments. 
-->
<Arguments>[Arguments]</Arguments>
<DataElements All="false">
<DataElement Name="Command" Type="string" Required="true">
<Documentation>
The command (executable, script etc) to run. This command can not have a user interface and can not wait for user input. If it does the plugin will just hang forever.
</Documentation>
</DataElement>
<DataElement Name="Arguments" Type="string" Required="false">
<Documentation>Optional arguments.</Documentation>
<DefaultValue/>
</DataElement>
</DataElements>
<!--
 The value describes where the plugin can be applied, e.g. Target, Source, WebServiceMethod
         Relative is where in relation to the pipeline position this plugin is executed 
-->
<PipelinePosition Optional="true" Relative="Pre" ExecutionOrder="50">Source</PipelinePosition>
<PipelinePosition Optional="true" Relative="Post" ExecutionOrder="50">Source</PipelinePosition>
<PipelinePosition Optional="true" Relative="Pre" ExecutionOrder="50">Target</PipelinePosition>
<PipelinePosition Optional="true" Relative="Post" ExecutionOrder="50">Target</PipelinePosition>
<PipelinePosition Optional="true" Relative="Inside" ExecutionOrder="50">Script</PipelinePosition>
</PipelinePlugin>
</JitterbitPlugin>
On This Page

Last updated:  Oct 29, 2019