Skip to end of metadata
Go to start of metadata


A File Share connection is configured using the File Share connector to establish access with a specific shared network. Once a connection is established, you can configure one or more File Share activities associated with that connection to use as a source or target within 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, within the Connectors filter, click the File Share connector block:

To configure an existing File Share connection, within the Endpoints filter, double-click the File Share connection block:

This will open a 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 typing an open square bracket [ into the field or click the variable icon to display 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 (:). As a specific connection and its activities are referred to as an endpoint, this name is also used to identify the File Share endpoint.
  • 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 & Password: Enter a username and password (if applicable) that will allow 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 this button to verify the connection to the file share using the provided credentials.
  • Save Changes: Click this button to save and close the connection configuration.
  • Discard Changes: After making changes to a new or existing configuration, click Discard Changes to close the configuration without saving. A message will ask you to confirm that you want to discard changes.
  • Delete: After opening an existing connection configuration, click Delete to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal).

Next Steps

After configuring a File Share connection, you can configure one or more File Share Read or Write activities associated with that connection to use as a source or target within an operation or script. For more information, see these activities:

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

Last updated:  Mar 05, 2020

  • No labels