Microsoft Excel v3 (Beta) connection in Jitterbit Studio

Introduction

A Microsoft Excel v3 (Beta) connection establishes the information needed to access a workbook file on the agent's own filesystem, within the agent's installation directory, or at a network location. This connection is required before creating any Microsoft Excel v3 (Beta) connector activities.

Note

This connector is currently in beta. To provide feedback, contact the Jitterbit Product Team.

Important

On Linux private agents, grant read and write access to both the configured folder and its files to the user account that runs the agent service. For details, see Prerequisites and supported API versions.

Create or edit a Microsoft Excel v3 (Beta) connection

A Microsoft Excel v3 (Beta) connection is created using the Microsoft Excel v3 (Beta) connector type.

To create an instance of a connection, drag the connector type to the design canvas or copy the connector type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Microsoft Excel v3 (Beta) connection can be edited from these locations:

The design canvas (see Component actions menu in Design canvas).
The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Microsoft Excel v3 (Beta) connection

Tip

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

Connection name: Enter a name to use to identify the connection. The name must be unique for each Microsoft Excel v3 (Beta) connection and must not contain forward slashes / or colons :. This name is also used to identify the Microsoft Excel v3 (Beta) endpoint, which refers to both a specific connection and its activities.
Storage Type: Select the storage type for the connection. Local (Agent Filesystem) is currently the only available option.
Local Path: Enter the path to the folder containing the workbook (.xlsx and .xls) files to use with this connection (for example, /opt/jitterbit/Connectors or C:\Jitterbit\excel). This folder can be a location on the agent's own filesystem, within the agent's installation directory, or at a network location, as long as the agent can reach the configured path.

The Local Path value is the endpoint unique identifier for a Microsoft Excel v3 (Beta) connection. Because this identifier is matched using a pattern that recognizes subpaths, a connection configured with /opt/jitterbit/Connectors/files is treated as the same endpoint as one configured with /opt/jitterbit/Connectors, while a connection configured with a different path, such as /tmp/files/, is treated as a distinct endpoint.
Test: Click to test the connection using the current field values.

Testing succeeds only when the configured Local Path meets all of the following conditions:
1. The path exists.
2. The path is a directory.
3. The directory is readable by the agent.
4. The directory is writable by the agent.
Save: Click to save the connection.
Discard changes: Click to discard unsaved changes.
Delete: Click to delete the connection.

Next steps

After configuring a Microsoft Excel v3 (Beta) connection, use one of the following activity types to create an instance of an activity for use in an operation:

Update Rows: Updates one or more existing rows of a worksheet and is intended to be used as a target in an operation.
Insert Rows: Writes one or more rows to a worksheet and is intended to be used as a target in an operation.
Delete Rows: Deletes one or more existing rows from a worksheet and is intended to be used as a target in an operation.
Read Rows: Reads rows from a worksheet and is intended to be used as a source in an operation.