Enable Local File Location¶

Introduction¶

By default, using local files is disabled for Harmony Private Agents. This includes using a Cloud Studio Local Storage endpoint or a Design Studio Local File source or target, as well as using trigger files or success/error 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 locations can be enabled only for Private Agents and cannot be enabled on Jitterbit Cloud Agents.

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

Determining If Local File Location Is Disabled¶

As 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, 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 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 a 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 Private Agent Configuration File¶

These abbreviated steps show how to enable local file storage remotely using the Management Console. For further instructions, see Edit 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 the 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 labeled EnableLocalFileLocation, set the Value to true.

   

5. Click Submit to complete the configuration change.

6. Restart the Private Agent for the changes to take effect.

Manually Modifying the Private Agent Configuration File¶

These abbreviated steps show how to enable local file storage by manually editing the configuration file. For further instructions, see Edit 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 (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:

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:

   EnableLocalFileLocation=true
   

3. Save and close the config file.

4. Restart the Private Agent for the changes to take effect.

Restart the 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:

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¶

These steps show how to confirm that 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 Private Agent you configured in the above steps.

2. Confirm that you can now use local file locations in Cloud Studio or Design Studio:

   • Cloud Studio: Create a new Local Storage connection, 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.

   Note

   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 or Agent Group.