Versions Compared

Key

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

Introduction

By default, using local files (either as a Local File files is disabled for Jitterbit Private Agents. This includes using a Cloud Studio local storage endpoint or a Design Studio local file source or target, as well as using a trigger file, files or using a success/error folder) is disabled for Jitterbit Private Agents. However, you folders that are configured on other endpoints or sources/targets.

You can enable local file locations if you need to work with a specific local directory or local files, or use the trigger file or success/error folder options.

Local File Location file locations can be enabled only for Private Agents and cannot be enabled on Jitterbit Cloud Agents.

Note that independent of this setting, Temporary Storage (Cloud Studio temporary storage endpoints and Design Studio temporary storage sources and targets) is always  are always available, both for Private and Cloud Agents.

Determining If Local File Location Is Disabled

As Local File Location is local file locations are disabled by default on Private Agents, if you have not yet configured your Private Agents to enable local file location, then upon testing the connection to a Cloud Studio local storage endpoint or Design Studio local file source or target in Design Studio, this error message will be displayed:

Using local files as a source/target, trigger file, or success/error folders is disabled by default.

Set EnableLocalFileLocation=true in the [Settings] section of jitterbit.conf and restart the Jitterbit Apache service to enable it.

Local File Location file location is disabled on the Cloud Agent Group, so the same error message will appear if you are using Cloud Agents. It is not possible to enable local file location for Cloud Agents.

Enabling Local File Location in the Jitterbit Private Agent

To enable local files, you need to edit the Private Agent's configuration file and then restart all Jitterbit services.

There are two ways to change the configuration file: remotely or manually. Remotely is simpler (especially with multiple Agents in an Agent Group), but manually may be preferable in certain scenarios.

Remotely Modifying the Jitterbit Configuration File 

These abbreviated steps show how to enable local file storage remotely using the Management Console. For further instructions, see Editing the Configuration File - jitterbit.conf.

  1. Log in to the Harmony Portal and select Management Console. Use the menu to navigate to Agents > Agent Groups.
  2. In the table, select your Private Agent Group and use its Action dropdown to select Jitterbit Conf.
  3. In the Config tab, click Edit. Scroll until you have reached the Settings row, as shown in the left column Configuration.
  4. For the Keys row labelled EnableLocalFileLocation, set the Value to true.

  5. Click Submit to complete the configuration change.
  6. Restart your Private Agent for the changes to take effect.

Manually Modifying the Jitterbit Configuration File

These abbreviated steps show how to enable local file storage by manually editing the configuration file. For further instructions, see Editing the Configuration File - jitterbit.conf.

On each machine where the Private Agent is installed, navigate to the Agent's configuration file. This will be located in its installation directory, usually in one of these locations: 

  • Windows (Jitterbit Harmony): C:\Program Files (x86)\Jitterbit Agent\jitterbit.conf
  • Windows (Jitterbit v5.x): C:\Program Files (x86)\Jitterbit Integration Server\jitterbit.conf
  • Linux: /opt/jitterbit/jitterbit.conf

For example, on a Windows OS system:

  1. Open the jitterbit.conf file in a text editor.
  2. Under the [Settings] section of the file, find the entry EnableLocalFileLocation:

    Change the line shown above in yellow to read:

    Code Block
    EnableLocalFileLocation=true
  3. Save and close the config file.
  4. Restart your Private Agent for the changes to take effect.

Restart Your Private Agent for the Changes to Take Effect

All Jitterbit services must be restarted in order for the config change to take place. On each machine where the Private Agent is installed, first stop the services, then restart them, using the appropriate procedure for the operating system:

OSProcedureMenu Items or Commands

Windows

Run the applications

"Stop Jitterbit Services"
"Start Jitterbit Services"
Linux

Use the commands

$ sudo jitterbit stop
$ sudo jitterbit start

Checking the Private Agent

To check that the Private Agent has restarted successfully, go to the Management Console and view the Agent. The status of the Private Agent should be "Running." The new configuration will now be in effect. For example:

Confirming Local File Location Is Enabled

You can use the Jitterbit Design Studio These steps show how to confirm that you can now use local file locations.Confirm that you are in an Environment local file locations are enabled. Even if you do not intend to use a local storage endpoint or local file source/target, you can use this procedure to confirm that a trigger file or a success/error folder will now be accessible on a certain Agent or Agent Group.

  1. Check that you are using an environment that uses the Jitterbit Private Agent you configured in the above steps.
If you are using a Cloud Agent (or a different Private Agent), you will receive the same error message as before, either because enabling local files is not possible using a Cloud Agent or because you have the wrong Agent (Group).Create a new Source or Target of the Local File type
  1. Confirm that you can now use local file locations in Cloud Studio or Design Studio:

    • Cloud Studio: Create a new local storage endpoint, specifying a local folder path. Click the Test button. A message should be displayed indicating the connection was successful.
    • Design Studio: Create a new local file source or target, specifying a local folder path and files. After your specific parameters are listed, click Test Connection. A message should be displayed indicating the connection was successful and display the local files.

Even if
  1. Info
    NOTE: If you are
not intending to use a Local File Source, you can use this procedure to confirm that on that Agent or Agent Group a trigger file or a success/error folder will now be accessible
  1. using a Cloud Agent (or a different Private Agent), you will receive the same error message as before, either because enabling local files is not possible using a Cloud Agent or because you have the wrong Agent (Group).
Panel
borderColor#65379B
titleColor#FFFFFF
titleBGColor#65379B
titleOn This Page
Table of Content Zone

Table of Contents
maxLevel3
minLevel2
indent20px

Panel
borderColor#FF7C4C
titleColor#FFFFFF
titleBGColor#FF7C4C
titleRelated Articles
Panel
borderColor#00B886
titleColor#FFFFFF
titleBGColor#00B886
titleRelated Topics

HideElements
metastrue

Last updated: 

Lastmodifieddate