Skip to end of metadata
Go to start of metadata


A File Share connection is configured using the File Share connector, establishing access to a shared network. Once a connection is established, you can configure one or more File Share 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.

Creating or Editing a File Share Connection

From the design canvas, open the Connectivity tab of the design component palette:

To configure a new File Share connection, use the Show dropdown to filter on Connectors, and then click the File Share connector block:

To configure an existing File Share connection, use the Show dropdown to filter on Endpoints, and then double-click the File Share connection block:

These open the configuration screen for the File Share connection, covered next.

Configuring a File Share Connection

Configuration of a File Share 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 File Share connection. The name must be unique for each File Share connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the File Share endpoint, which refers to both a specific connection and its activities.
  • Path: Enter the Universal Naming Convention (UNC) file share path(s) that you want to read from or write to, excluding filename(s). When entering a path, use this format: \\servername\sharename\path\. In addition, take note:
    • UNC paths must start with two backslashes \\ but a trailing backslash \ is optional (for example, \\dropserver\incoming\po).
    • An IP address can be used in place of the server name (for example, \\\mydir).
    • Multiple paths can be specified using comma-separated values (for example, \\myserver\mydir, \\\mydir).
  • Login and Password: Enter a username and password (if applicable) that allows access to the file share. The username for a Windows SMB file share should be in the form of DomainName\Username). You can leave the password field blank if no password is required.

    CAUTION: The file share connection credentials that you provide must be sufficient to perform the activities configured for the connection. For limitations as a result of restrictions imposed by the file share you are accessing, see Important Notes under File Share.
  • Test: Click to verify the connection using the provided credentials.
  • 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 configuring a File Share connection, you can configure one or more File Share 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 File Share connection block to display activities that are available to be used with a File Share connection:

For more information, see these activities:

  • Read: Reads data from a File Share endpoint and is intended to be used as a source in an operation or called in a script.
  • Write: Writes data to a File Share endpoint and is intended to be used as a target in an operation or called in a script.
On This Page

Last updated:  Nov 24, 2020

  • No labels