Microsoft Excel Connector¶

Summary¶

The Microsoft Excel connector establishes access to Microsoft Excel.

Important

We recommend using the Microsoft Excel v2 connector to connect to Microsoft Excel as it improves the usability of the connection configuration UI and allows for additional configuration properties.

The Microsoft Excel connector provides an interface for creating a Microsoft Excel connection, the foundation used for generating instances of Microsoft Excel activities. These activities, once configured, interact with Microsoft Excel through the connection.

The Microsoft Excel connector is accessed from the design component palette's Connections tab (see Design Component Palette).

WARNING: While the connector is capable of pulling data from Excel files hosted on a variety of cloud data stores using its Query activity, the Create, Update, and Delete activities are not supported outside of local files in this connector. See Establishing a Connection for details.

Note

This connector can be used only with Private Agents. In addition, it is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Connection Documentation¶

In addition to the Microsoft Excel connection, see the comprehensive Microsoft Excel connection details page. Configuration details such as these are included on that page:

Getting Started: Initial steps for establishing a connection.
Advanced Features: User-defined views and SSL configuration.
Data Model: The data model that the connector uses to represent the endpoint.
Advanced Configurations Properties: Properties that can be defined to configure a connection for both basic and advanced configurations.

Activity Documentation¶

Together, a specific Microsoft Excel connection and its activities are referred to as a Microsoft Excel endpoint:

Microsoft Excel activity types

Query: Retrieves records from a table at Microsoft Excel and is intended to be used as a source in an operation.
Create: Inserts a record into a table at Microsoft Excel and is intended to be used as a target in an operation.
Update: Updates a record in a table at Microsoft Excel and is intended to be used as a target in an operation.
Delete: Deletes a record from a table at Microsoft Excel and is intended to be used as a target in an operation.
Execute: Executes a procedure at Microsoft Excel and is intended to be used as a target in an operation.

Prerequisites and Supported API Versions¶

The Microsoft Excel connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

This connector requires the use of a Private Agent.

Refer to the endpoint documentation for information on the schema nodes and fields.

OAuth Authentication¶

OAuth authentication is supported as described in Configure OAuth Connections.

Troubleshooting¶

If you experience issues with the Microsoft Excel connector, these troubleshooting steps are recommended:

Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).
Check the operation logs for any information written during execution of the operation.
Enable operation debug logging for Private Agents to generate additional log files and data.
Enable connector verbose logging for this connector using this specific configuration entry of logger name and level:
```
<logger name="org.jitterbit.connector.verbose.logging.Excel" level="TRACE"/>
```
Check the agent logs for more information.