Skip to end of metadata
Go to start of metadata

Introduction

A Local Storage connection is configured using the Local Storage connector, establishing access to storage on the Private Agent machine. Once a connection is established, you can configure one or more Local Storage activities associated with that connection to be used either as a source to provide data to an operation or script, or as a target to consume data in an operation or script.

Prerequisites

To use local storage, you must be using a Jitterbit Harmony Private Agent, and the local storage must reside on the machine where the Private Agent is installed.

CAUTION: Local Storage endpoints cannot be used with Cloud Agents.

In addition, you must have the Private Agent configured to allow Local Storage connections. By default, Private Agents are configured to prevent use of local storage. See Enabling Local File Location to change the default setting in the Private Agent configuration file to enable Local Storage connections.

Creating or Editing a Local Storage Connection

A new Local Storage connection is created using the Local Storage connector from the design component palette's Connectivity tab (see Connectors in Design Component Palette).

An existing Local Storage connection can be edited from these locations:

Configuring a Local Storage Connection

Configuration of a Local Storage connection includes these fields:

TIP: Fields with a variable icon  support using global variablesproject variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Endpoint Name: Enter a name to use to identify the Local Storage connection. The name must be unique for each Local Storage connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Local Storage endpoint, which refers to both a specific connection and its activities.
  • Path: Enter the directory location(s) that contain the files you want to read from or write to. The location(s) must be on the machine where the Private Agent is installed, and the path separators (forward slash / or backslash \) must be appropriate for the operating system of the machine where the Private Agent is installed. For example, /home/user/Documents/ on Linux or C:\projects\My Project\ on Windows. If the connection will be used for a target activity, you can enter multiple paths separated by a comma to write to multiple destinations. For example, C:\tmp, D:\tmp.

  • Test: Click to verify the connection. If you receive an error, make sure that the specified folder path(s) exist and that you have enabled local files as described in Enabling Local File Location.
  • Save Changes: Click to save and close the connection configuration.
  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps

After a Local Storage connection has been created, menu actions for that connection are accessible from the project pane's Components tab. See Connection Actions Menu for details.

Once configuring a Local Storage connection, you can configure one or more Local Storage activities associated with that connection to be used either as a source (to provide data within an operation) or as a target (to consume data within an operation), or to be used in a script.

Use the Show dropdown to filter on Endpoints, and then click the Local Storage connection block to display activities that are available to be used with a Local Storage connection:

For more information, see these activities:

  • Read: Reads data from a Local Storage endpoint and is intended to be used as a source in an operation or called in a script.
  • Write: Writes data to a Local Storage endpoint and is intended to be used as a target in an operation or called in a script.

  • No labels