Microsoft Excel v2 Connection Details in Jitterbit Studio

Introduction

Connector Version

This documentation is based on version 26.0.9719 of the connector.

Get Started

Microsoft Excel Version Support

The Jitterbit Connector for Microsoft Excel supports the Office Open XML spreadsheets used by Microsoft Excel 2007 and later.

Microsoft Excel File Extension Support

The Jitterbit Connector for Microsoft Excel currently supports .xlsx and .xlsm files. However, only read operations are supported for .xlsm files. Modifying data operations may cause loss of or damage to macros.

View Remote Microsoft Excel Metadata

The Jitterbit Connector for Microsoft Excel is designed for streaming Microsoft Excel only.

This streamed file content does not include all of the metadata associated with remotely stored Microsoft Excel files, such as file and folder name.

If access to both the file metadata and the actual file content is needed, then the Jitterbit Connector for Microsoft Excel must be used in tandem with the associated file system driver(s) for the service the Microsoft Excel files are remotely stored in.

The following file system drivers are available:

AmazonS3
Box
Dropbox
FTP
Google Cloud Storage
IBM Cloud Object Storage
OneDrive
SFTP

See the relevant file system driver's documentation for a configuration guide for connecting to stored Microsoft Excel file metadata.

Establish a Connection

The Jitterbit Connector for Microsoft Excel allows connecting to local and remote Excel resources. Set the URI property to the Excel resource location, in addition to any other properties necessary to connect to your data source.

Connect to Cloud-Hosted Microsoft Excel Files

While the connector is capable of pulling data from Microsoft Excel files hosted on a variety of cloud data stores, INSERT, UPDATE, and DELETE are not supported outside of local files in this connector.

If you need INSERT/UPDATE/DELETE cloud files, you can download the corresponding connector for that cloud host (supported via stored procedures), make changes with the local file's corresponding connector, then upload the file using the cloud source's stored procedures.

As an example, if you wanted to update a file stored on SharePoint, you could use the SharePoint connector's DownloadDocument procedure to download the Microsoft Excel file, update the local Microsoft Excel file with the Microsoft Excel connector, then use the SharePoint connector's UploadDocument procedure to upload the changed file to SharePoint.

A unique prefix at the beginning of the URI connection property is used to identify the cloud data store being targed by the connector and the remainder of the path is a relative path to the desired folder (one table per file) or single file (a single table).

Amazon S3

Set the following to identify your Microsoft Excel resources stored on Amazon S3:

ConnectionType: Set the ConnectionType to Amazon S3.
URI: Set this to an Excel file in a bucket: s3://bucket1/folder1/file.xlsx.
- You can also connect to Microsoft Excel resources stored on Cloudera Ozone, after creating a volume and bucket and making a symbolic link to that bucket: s3://linktobucket/file.xlsx

See Connecting to Amazon S3 for more information regarding how to connect and authenticate to Excel files hosted on Amazon S3.

Azure Blob Storage

Set the following to identify your Microsoft Excel resources stored on Azure Blob Storage:

ConnectionType: Set this to Azure Blob Storage.
URI: Set this to the name of your container and the name of the blob. For example: azureblob://mycontainer/myblob/file.xlsx.

See Connecting to Azure Blob Storage for more information regarding how to connect and authenticate to Excel files hosted on Amazon Blob Storage.

Azure Data Lake Storage

Set the following to identify your Microsoft Excel resources stored on Azure Data Lake Storage:

ConnectionType: Set this to Azure Data Lake Storage Gen1, Azure Data Lake Storage Gen2, or Azure Data Lake Storage Gen2 SSL.
URI: Set this to the name of the file system, the name of the folder which contains your Microsoft Excel files, and the name of an Excel file. For example:
- Gen 1: adl://myfilesystem/folder1/file.xlsx
- Gen 2: abfs://myfilesystem/folder1/file.xlsx
- Gen 2 SSL: abfss://myfilesystem/folder1/file.xlsx

See Connecting to Azure Data Lake Storage for more information regarding how to connect and authenticate to Excel files hosted on Azure Data Lake Storage.

Azure File Storage

Set the following properties to connect:

ConnectionType: Set this to Azure Files.
URI: Set this the name of your azure file share and the name of the resource. For example: azurefile://fileShare/remotePath/file.xlsx.
AzureStorageAccount (Required): Set this to the account associated with the Azure file.

You can authenticate either an Azure access key or an Azure shared access signature. Set one of the following:

AzureAccessKey: Set this to the access key associated with the Azure file.
AzureSharedAccessSignature: Set this to the shared access signature associated with the Azure file.

Box

Set the following to identify your Microsoft Excel resources stored on Box:

ConnectionType: Set this to Box.
URI: Set this the name of the file system, the name of the folder which contains your Microsoft Excel files, and the name of an Excel file. For example: box://folder1/file.xlsx.

See Connecting to Box for more information regarding how to connect and authenticate to Excel files hosted on Box.

Dropbox

Set the following to identify your Microsoft Excel resources stored on Dropbox:

ConnectionType: Set this to Dropbox.
URI: Set this to the path to a Excel file. For example: dropbox://folder1/file.xlsx.

See Connecting to Dropbox for more information regarding how to connect and authenticate to Excel files hosted on Dropbox.

FTP

The connector supports both plaintext and SSL/TLS connections to FTP servers.

Set the following connection properties to connect:

ConnectionType: Set this to either FTP or FTPS.
URI: Set this to the address of the server followed by the path to the Excel file. For example: `ftp://localhost:990/folder1/file.xlsxorftps://localhost:990/folder1`.
User: Set this to your username on the FTP(S) server you want to connect to.
Password: Set this to your password on the FTP(S) server you want to connect to.

Google Cloud Storage

Set the following to identify your Microsoft Excel resources stored on Google Cloud Storage:

ConnectionType: Set this to Google Cloud Storage.
URI: Set this to the path to the name of the file system, the name of the folder which contains your Microsoft Excel files, and the name of a Excel file. For example: gs://bucket/remotePath/file.xlsx.

See Connecting to Google Cloud Storage for more information regarding how to connect and authenticate to Excel files hosted on Google Cloud Storage.

Google Drive

Set the following to identify your Microsoft Excel resources stored on Google Drive:

ConnectionType: Set this to Google Drive.
URI: Set to the path to the name of the file system, the name of the folder which contains your Microsoft Excel files, and the name of an Excel file. For example: gdrive://folder1/file.xlsx.

See Connecting to Google Drive for more information regarding how to connect and authenticate to Excel files hosted on Google Drive.

HDFS

Set the following to identify your Microsoft Excel resources stored on HDFS:

ConnectionType: Set this to HDFS or HDFS Secure.
URI: Set this to the path to a Excel file. For example:
- HDFS: webhdfs://host:port/remotePath/file.xlsx
- HDFS Secure: webhdfss://host:port/remotePath/file.xlsx
- Cloudera Ozone (via the HttpFS gateway): webhdfs://<Ozone server>:<port>/user/myuser/file.xlsx
  - You must use Kerberos authentication to access Microsoft Excel files stored on Ozone.
  - Ensure that you have Ozone 718.2.x on the Ozone cluster.
  - Cloudera Manager version 7.10.1 is required.

There are two authentication methods available for connecting to HDFS data source, Anonymous Authentication and Negotiate (Kerberos) Authentication.

Anonymous Authentication

In some situations, you can connect to HDFS without any authentication connection properties. To do so, set the AuthScheme property to None (default).

Authenticate using Kerberos

When authentication credentials are required, you can use Kerberos for authentication. See Using Kerberos for details on how to authenticate with Kerberos.

HTTP Streams

Set the following to identify your Microsoft Excel resources stored on HTTP streams:

ConnectionType: Set this to HTTP or HTTPS.
URI: Set this to the URI of your HTTP(S) stream. For example:
- HTTP: http://remoteStream/file.xlsx
- HTTPS: https://remoteStream/file.xlsx

See Connecting to HTTP Streams for more information regarding how to connect and authenticate to Excel files hosted on HTTP Streams.

IBM Cloud Object Storage

Set the following to identify your Microsoft Excel resources stored on IBM Cloud Object Storage:

ConnectionType: Set this to IBM Object Storage Source.
URI: Set this to the bucket and folder. For example: ibmobjectstorage://bucket1/remotePath/file.xlsx.
Region: Set this property to your IBM instance region. For example: eu-gb.

See Connecting to IBM Object Storage for more information regarding how to connect and authenticate to Excel files hosted on IBM Cloud Object Storage.

OneDrive

Set the following to identify your Microsoft Excel resources stored on OneDrive:

ConnectionType: Set this to OneDrive.
URI: Set this to the path to a Excel file. For example: onedrive://remotePath/file.xlsx.

See Connecting to OneDrive for more information regarding how to connect and authenticate to Excel files hosted on OneDrive.

OneLake

Set the following to identify your Microsoft Excel resources stored on OneLake:

ConnectionType: Set this to OneLake.
URI: Set this to the name of the workspace, followed by the item and item type. Optionally, include the folder path to be used as the root folder. For example: onelake://Workspace/Test.LakeHouse/Files/CustomFolder/file.xlsx.

See Connecting to OneLake for more information regarding how to connect and authenticate to Excel files hosted on OneLake.

Oracle Cloud Storage

Set the following properties to authenticate with IAMSecretKey:

ConnectionType: Set the ConnectionType to Oracle Cloud Storage.
URI: Set this to an Excel file in a bucket: os://bucket/remotePath/file.xlsx.
AccessKey: Set this to an Oracle Cloud Access Key.
SecretKey: Set this to an Oracle Cloud Secret Key.
OracleNamespace: Set this to an Oracle cloud namespace.
Region (optional): Set this to the hosting region for your S3-like Web Services.

SFTP

Set the following to identify your Microsoft Excel resources stored on SFTP:

ConnectionType: Set this to SFTP.
URI: Set this to the address of the server followed by the path. For example: sftp://server:port/remotePath/file.xlsx.

See Connecting to SFTP for more information regarding how to connect and authenticate to Excel files hosted on SFTP.

SharePoint Online

Set the following to identify your Microsoft Excel resources stored on SharePoint Online:

ConnectionType: Set this to SharePoint GRAPH or SharePoint REST V1.
URI: Set this to a document library containing Excel files. For example:
- SharePoint Online GRAPH: spgraph://remotePath/file.xlsx
- SharePoint Online REST V1: sprestv1://remotePath/file.xlsx
  
  Use the Sharepoint URL as the remote path. Not the display name.

If your files are stored in a non-root-level SharePoint Online site (for example, under /sites/<your site>/), be sure to set the StorageBaseURL property to the full path of the SharePoint site.

To access files in the top-level document library:
- URI: Set this to spgraph://Documents/ or sprestv1://Documents/
- StorageBaseURL: Set this to https://<your domain>.sharepoint.com/sites/<your site>/
To access a subfolder within that site:
- URI: Set this to spgraph://Documents/<subfolder>/ or sprestv1://Documents/<subfolder>/
- StorageBaseURL: Set this to https://<your domain>.sharepoint.com/sites/<your site>/

Using the full SharePoint site URL ensures the connector can properly locate files stored in non-root-level locations within your organization's SharePoint Online environment.

See Connecting to SharePoint Online for more information regarding how to connect and authenticate to Excel files hosted on SharePoint Online.

SharePoint On Premise

Set the following to identify your Microsoft Excel resources stored on SharePoint On Premise:

ConnectionType: Set this to SharePoint REST V1 or SharePoint SOAP.
URI: Set this to a document library containing Excel files. For example:
- SharePoint On Premise REST V1: sprestv1://remotePath/file.xlsx
- SharePoint On Premise SOAP: sp://remotePath/file.xlsx
  
  Use the Sharepoint URL as the remote path. Not the display name.

See Connecting to SharePoint On Premise for more information regarding how to connect and authenticate to Excel files hosted on SharePoint On Premise.

Connect to a Workbook

The URI, under the Connection section, must be set to a valid Excel File (including the file path). The connector supports the Office Open XML format used by Excel 2007 and later.

Query a Workbook

You can then execute SELECT, INSERT, UPDATE, and DELETE statements to spreadsheets and ranges in the workbook. See Excel Operations for details on querying spreadsheet data as tables.

Connect to Amazon S3

Before You Connect

Obtain AWS Keys

To obtain the credentials for an IAM user:

Sign into the IAM console.
In the navigation pane, select Users.
To create or manage the access keys for a user, select the user and then navigate to the Security Credentials tab.

To obtain the credentials for your AWS root account:

Sign into the AWS Management console with the credentials for your root account.
Select your account name or number.
In the menu that displays, select My Security Credentials.
To manage or create root account access keys, click Continue to Security Credentials and expand the "Access Keys" section.

Connect to Amazon S3

Specify the following to connect to data:

AWSRegion: Set this to the region where your Microsoft Excel data is hosted.
StorageBaseURL (optional): Specify the base S3 service URL only if it has a different URL from "amazonaws.com". Make sure to specify the full URL. For example: http://127.0.0.1:9000.

Authenticate to Amazon S3

There are several authentication methods available for connecting to Microsoft Excel including:

Root Credentials
AWS Role, as an AWS Role (from an EC2 Instance or by specifying the root credentials)
SSO (ADFS, Okta, PingFederate)
Temporary Credentials
Credentials File
EKS Pod Identity

Root Credentials

To authenticate using account root credentials, set these parameters:

AuthScheme: AwsRootKeys.
AWSAccessKey: The access key associated with the AWS root account.
AWSSecretKey: The secret key associated with the AWS root account.

Note

Amazon discourages using root credentials for anything beyond simple testing. The account root credentials have the full permissions of the user, posing a security risk and making this the least secure authentication method.

If multi-factor authentication is required, specify the following:

CredentialsLocation: The location of the settings file where MFA credentials are saved.
MFASerialNumber: The serial number of the MFA device if one is being used.
MFAToken: The temporary token available from your MFA device.

This causes the connector to submit the MFA credentials in the request to retrieve temporary authentication credentials.

Note

If you want to control the duration of the temporary credentials, set the TemporaryTokenDuration property (default: 3600 seconds).

Use AWS From an EC2 Instance

Set AuthScheme to AwsEC2Roles.

If you are using the connector from an EC2 Instance and have an IAM Role assigned to the instance, you can use the IAM Role to authenticate. Since the connector automatically obtains your IAM Role credentials and authenticates with them, it is not necessary to specify AWSAccessKey and AWSSecretKey.

If you are also using an IAM role to authenticate, you must additionally specify the following:

AWSRoleARN: Specify the Role ARN for the role you'd like to authenticate with. This causes the connector to attempt to retrieve credentials for

the specified role.
AWSExternalId (optional): Only required if you are assuming a role in another AWS account.

IMDSv2 Support

The Microsoft Excel connector now supports IMDSv2. Unlike IMDSv1, the new version requires an authentication token. Endpoints and response are the same in both versions.

In IMDSv2, the Microsoft Excel connector first attempts to retrieve the IMDSv2 metadata token and then uses it to call AWS metadata endpoints. If it is unable to retrieve the token, the connector reverts to IMDSv1.

AWS Web Identity

Set AuthScheme to AwsWebIdentity.

If you are either using Microsoft Excel from a container configured to assume role with web identity (such as a Pod in an EKS cluster with an OpenID Provider) or have authenticated with a web identity provider associated with an IAM role (and have thus obtained an identity token), you can exchange the web identity token and IAM role information for temporary security credentials to authenticate and access AWS services.

If the container has AWS_ROLE_ARN and AWS_WEB_IDENTITY_TOKEN_FILE specified in the environment variables, Microsoft Excel automatically obtains the credentials.

You can also authenticate by specifying both AWSRoleARN and AWSWebIdentityToken to execute the AssumeRoleWithWebIdentity API operation.

{: #section}

AWS IAM Roles

To authenticate through AWS, set AuthScheme to AwsIAMRoles.

To authenticate as an AWS role, set these properties:

AWSAccessKey: The access key of the IAM user to assume the role for.
AWSSecretKey: The secret key of the IAM user to assume the role for.
AWSRoleARN: Specify the Role ARN for the role you'd like to authenticate with. This will cause the connector to attempt to retrieve credentials for

the specified role.
AWSExternalId (optional): Only required if you are assuming a role in another AWS account.

If multi-factor authentication is required, specify the following:

CredentialsLocation: The location of the settings file where MFA credentials are saved.
MFASerialNumber: The serial number of the MFA device if one is being used.
MFAToken: The temporary token available from your MFA device.

This causes the connector to submit the MFA credentials in the request to retrieve temporary authentication credentials.

Note

If you want to control the duration of the temporary credentials, set the TemporaryTokenDuration property (default: 3600 seconds). !!! note In some circumstances it might be preferable to use an IAM role for authentication, rather than the direct security credentials of an AWS root user. If you are specifying the AWSAccessKey and AWSSecretKey of an AWS root user, you cannot use roles.

ADFS

To connect to ADFS, set these properties:

AuthScheme: ADFS.
User: The authenticating ADFS user.
Password: The password of the authenticating ADFS user.
SSOLoginURL: The SSO provider's login URL.

To authenticate to ADFS, set these SSOProperties:

RelyingParty: The value of the ADFS server's Relying Party Identifier.

Example connection string:

AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';SSOProperties='RelyingParty=https://saml.salesforce.com';

Okta

To connect to Okta, set these properties:

AuthScheme: Okta.
User: The authenticating Okta user.
Password: The password of the authenticating Okta user.
SSOLoginURL: The SSO provider's login URL.

If you are either using a trusted application or proxy that overrides the Okta client request OR configuring MFA, you must use combinations of SSOProperties to authenticate using Okta. Set any of the following, as applicable:

APIToken: When authenticating a user via a trusted application or proxy that overrides the Okta client request context, set this to the API Token the customer created from the Okta organization.
MFAType: If you have configured the MFA flow, set this to one of the following supported types: OktaVerify, Email, or SMS.
MFAPassCode: If you have configured the MFA flow, set this to a valid passcode.

If you set this to empty or an invalid value, the connector issues a one-time password challenge to your device or email. After the passcode is received, reopen the connection where the retrieved one-time password value is set to the MFAPassCode connection property.
MFARememberDevice: True by default. Okta supports remembering devices when MFA is required. If remembering devices is allowed according to the configured authentication policies, the connector sends a device token to extend MFA authentication lifetime. If you do not want MFA to be remembered, set this variable to False.

Example connection string:

AuthScheme=Okta;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;

PingFederate

To connect to PingFederate, set these properties:

AuthScheme: PingFederate.
User: The authenticating PingFederate user.
Password: The authenticating user's PingFederate password.
SSOLoginURL: The SSO provider's login URL.
AWSRoleARN (optional): If you have multiple role ARNs, specify the one you want to use for authorization.
AWSPrincipalARN (optional): If you have multiple principal ARNs, specify the one you want to use for authorization.
SSOExchangeURL: The Partner Service Identifier URI configured in your PingFederate server instance under: SP Connections > SP Connection > WS-Trust > Protocol Settings. This should uniquely identify a PingFederate SP Connection, so it is a good idea to set it to your AWS SSO ACS URL. You can find it under AWS SSO > Settings > View Details next to the Authentication field.
SSOProperties (optional): If you want to include your username and password as an authorization header in requests to Amazon S3, set this to Authscheme=Basic.

To enable mutual SSL authentication for SSOLoginURL, the WS-Trust STS endpoint, configure these SSOProperties:

SSLClientCert
SSLClientCertType
SSLClientCertSubject
SSLClientCertPassword

Example connection string:

authScheme=pingfederate;SSOLoginURL=https://mycustomserver.com:9033/idp/sts.wst;SSOExchangeURL=https://us-east-1.signin.aws.amazon.com/platform/saml/acs/764ef411-xxxxxx;user=admin;password=PassValue;AWSPrincipalARN=arn:aws:iam:215338515180:saml-provider/pingFederate;AWSRoleArn=arn:aws:iam:215338515180:role/SSOTest2;

Temporary Credentials

To authenticate using temporary credentials, specify the following:

AuthScheme: AwsTempCredentials.
AWSAccessKey: The access key of the IAM user who will assume the role.
AWSSecretKey: The secret key of the IAM user who will assume the role.
AWSSessionToken: Your AWS session token, provided with your temporary credentials. For details, see AWS Identity and Access Management User Guide.

The connector can now request resources using the same permissions provided by long-term credentials (such as IAM user credentials) for the lifespan of the temporary credentials.

To authenticate using both temporary credentials and an IAM role, set all the parameters described above, and specify these additional parameters:

AWSRoleARN: The Role ARN for the role you'd like to authenticate with. This prompts the connector to retrieve credentials for the specified role.
AWSExternalId (optional): Only required if you are assuming a role in another AWS account.

If multi-factor authentication is required, specify the following:

CredentialsLocation: The location of the settings file where MFA credentials are saved.
MFASerialNumber: The serial number of the MFA device if one is being used.
MFAToken: The temporary token available from your MFA device.

This causes the connector to submit the MFA credentials in the request to retrieve temporary authentication credentials.

Note

If you want to control the duration of the temporary credentials, set the TemporaryTokenDuration property (default: 3600 seconds).

Credentials Files

You can use any credentials file to authenticate, including any configurations related to AccessKey/SecretKey authentication, temporary credentials, role authentication, or MFA.

To do this, set these properties:

AuthScheme: AwsCredentialsFile.
AWSCredentialsFile: The location of your credentials file.
AWSCredentialsFileProfile (optional): The name of the profile you would like to use from the specified credentials file. If not specified, the default profile is used.

For further information, see AWS Command Line Interface User Guide.

EKS Pod Identity

Set AuthScheme to EKSPodIdentity.

If you are running Microsoft Excel from a Pod in an Amazon EKS cluster configured with EKS Pod Identity, the connector automatically retrieves temporary credentials from the EKS Pod Identity Agent running on the node.

The EKS Pod Identity Agent sets the AWS_CONTAINER_CREDENTIALS_FULL_URI and AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE environment variables in the Pod. The connector reads these environment variables to obtain credentials.

If the environment variables are not available, you can specify the values manually using AWSContainerCredentialsFullURI and AWSContainerAuthorizationTokenFile.

Microsoft Entra ID

This configuration requires two separate Microsoft Entra ID applications:

The "Microsoft Excel" application used for single sign-on, and
A custom OAuth application with user_impersonation permission on the "Microsoft Excel" application. (See Creating a Custom OAuth App.)

To connect to Microsoft Entra ID, set the AuthScheme to Microsoft Entra ID, and set these properties:

OAuthClientId: The application ID of the connector application, listed in the Overview section of the app registration.
OAuthClientSecret: The client secret value of the connector application. Microsoft Entra ID displays this when you create a new client secret.
CallbackURL: The redirect URI of the connector application. For example: https://localhost:33333.
InitiateOAuth: Set this to GETANDREFRESH.

To authenticate to Microsoft Entra ID, set these SSOProperties:

Resource: The application ID URI of the Microsoft Excel application, listed in the app registration's Overview section. In most cases this is the URL of your custom Microsoft Excel domain.
AzureTenant: The ID of the Microsoft Entra ID tenant where the applications are registered.

Example connection string:

AuthScheme=Microsoft Entra ID;InitiateOAuth=GETANDREFRESH;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;CallbackUrl=https://localhost:33333;SSOProperties='Resource=https://signin.aws.amazon.com/saml;AzureTenant=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';

Connect to Azure Blob Storage

Before You Connect

To obtain the credentials for an AzureBlob user, follow the steps below:

Sign into the Azure portal with the credentials for your root account.
Click on Storage Accounts and select the storage account you want to use.
Under Settings, click Access keys.
Your storage account name and key will be displayed on that page.

Connect to Azure Blob Storage

Set AzureStorageAccount to your Azure Blob Storage account name.

Authenticate to Azure Blob Storage

You can authenticate to Azure Blob Storage via Access Key, Shared Access Signatures (SAS), Microsoft Entra ID user, Managed identities for Azure resources, or Microsoft Entra service principal.

Access Key

Set the following to authenticate with an Azure Access Key:

AuthScheme: Set this to AccessKey.
AzureAccessKey: Set this to the storage key associated with your Azure Blob Storage account.

Shared Access Signature (SAS)

Set the following to authenticate with an Shared Access Signature (SAS):

AuthScheme: Set this to AzureStorageSAS.
AzureSharedAccessSignature: Set this to the SAS associated with your Azure Blob Storage account.

Follow these steps to create a shared access signature using AzureSharedAccessSignature:

Sign into the Azure Portal with the credentials for your root account. (https://portal.azure.com/)
Click storage accounts and select the storage account you want to use.
Under settings, click Shared Access Signature.
Set the permissions.
Specify when you want the token to expire.
Click Generate SAS and copy the shared access signature it generates.
Set AzureSharedAccessSignature to the shared access signature from the previous step.

Microsoft Entra ID User

AuthScheme must be set to Microsoft Entra ID in all user account flows.

Desktop Applications

The connector provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId (custom applications only): Set this to the client ID assigned when you registered your app.
OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.
CallbackURL (custom application only): Set this to the redirect URI defined when you registered your app. For example: http://localhost:33333

When you connect, the connector opens the Microsoft identity platform's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

The connector obtains an access token from the Microsoft identity platform and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Microsoft Entra service principal

Authentication as a Microsoft Entra service principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself.

All tasks taken by the application are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For Microsoft Entra service principal authentication, set AuthScheme to AzureServicePrincipal.

Creating an Microsoft Entra ID App and a Microsoft Entra service principal

If you will authenticate using a Microsoft Entra service principal, you must first create and register a Microsoft Entra ID application with a Microsoft Entra ID tenant, as described in Creating an Entra ID (Microsoft Entra ID) Application.

In portal.azure.com, navigate to App Registration > API Permissions. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under Application Permissions.

Assigning a role to the application

To access resources in your subscription, you must assign an appropriate role to the custom Microsoft Entra ID application. Do the following:

Use the search bar to locate the Subscriptions service.
Open the Subscriptions page.
Select the subscription to which to assign the application.
Open Access control (IAM) and select Add > Add role assignment. The Add role assignment page opens.
Assign your custom Microsoft Entra ID application the Owner role.

Setting the connection properties

The connection properties you set to connect with your custom Microsoft Entra ID application will vary, depending on whether you want to authenticate using a Client Secret or a Certificate.

After you connect, authentication with client credentials takes place automatically like any other connection, except that no window opens to prompt the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Client Secret Connection Properties

AuthScheme: AzureServicePrincipal.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthClientId: The client ID in your custom Microsoft Entra ID application settings.
OAuthClientSecret: The client secret in your custom Microsoft Entra ID application settings.

Certificate Connection Properties

AuthScheme: AzureServicePrincipalCert.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthJWTCert: The JWT Certificate store.
OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.
OAuthJWTIssuer: The issuer of the Java Web Token.

Note

In most cases, OAuthJWTIssuer takes the value of the OAuthClientId property and does not need to be individually set.

Managed identities for Azure resources

If you are connecting from an Azure VM with permissions for Azure Data Lake Storage, set AuthScheme to AzureMSI.

Create a Custom OAuth App

There are two types of custom app registrations: Microsoft Entra ID and Microsoft Entra ID with a Microsoft Entra service principal. Both are OAuth-based.

When to Create a Custom Application

The connector embeds OAuth Application Credentials with branding that can be used when connecting via either a Desktop Application or from a Headless Machine.

You may choose to use your own Microsoft Entra ID Application Credentials when you want to:

control branding of the Authentication Dialog
control the redirect URI that the application redirects the user to after the user authenticates
customize the permissions that you are requesting from the user

Custom Microsoft Entra ID Applications

You can use a custom app registration to authenticate a service account or a user account. You can always create a custom app registration, but note that desktop and headless connections support embedded OAuth, which simplifies the process of authentication. See "Establishing a Connection" for information about using the embedded OAuth application.

Create a Custom Microsoft Entra ID App

Follow the steps below to obtain the Microsoft Entra ID values for your application, the OAuthClientId and OAuthClientSecret.

Log in to https://portal.azure.com.
In the left-hand navigation pane, select All services. Filter and select App registrations.
Click New registrations.
Enter an application name and select the desired tenant setup.

When creating a custom app registration in Microsoft Entra ID, you can define whether the application is single- or multi-tenant. If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Microsoft Entra ID Tenant when establishing a connection with the Jitterbit Connector for Microsoft Excel. Otherwise, the authentication attempt fails with an error. If your application is for private use only, "Accounts in this organization directory only" should be sufficient. Otherwise, if you want to distribute your application, choose one of the multi-tenant options.
Set the redirect URL to http://localhost:33333, the connector's default. Or, specify a different port and set CallbackURL to the exact reply URL you defined.
Click Register to register the new application. This opens an application management screen. Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
Navigate to the "Certificates & Secrets" and define the application authentication type. There are two types of authentication available: using a client secret or a certificate. The recommended authentication method is using a certificate.
- Option 1: Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
- Option 2: Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will need it as the OAuthClientSecret.
Select API Permissions > Add. If your application connects without a user context, select Application Permissions. If your application authenticates on behalf of a signed-in user, choose Delegated permissions.
Save your changes.
If you have selected to use permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page. Otherwise, follow the steps under "Admin Consent".

Custom Microsoft Entra ID Service Principal Applications

When authenticating using a Microsoft Entra service principal, you must create both a custom app registration and a service principal that can access the necessary resources. Follow the steps below to create a custom app registration and obtain the connection properties for Microsoft Entra service principal authentication.

Create a Custom Microsoft Entra ID App with a Microsoft Entra service principal

Follow the steps below to obtain the Microsoft Entra ID values for your application.

Log in to https://portal.azure.com.
In the left-hand navigation pane, select All services. Filter and select App registrations.
Click New registrations.
Enter an app name and select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant). Then set the redirect URL to http://localhost:33333, the connector's default.
After creating the application, copy the Application (client) ID value displayed in the "Overview" section. This value is used as the OAuthClientId
Define the app authentication type by going to the "Certificates & Secrets" section. There are two types of authentication available: using a client secret and using a certificate. The recommended authentication method is via a certificate.
- Option 1 - Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
- Option 2 - Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will use it as the OAuthClientSecret.
On the Authentication tab, make sure to select Access tokens (used for implicit flows).

Connect to Azure Data Lake Storage

Set AzureStorageAccount to the name of your Azure Data Lake Storage account.

Authenticate to Azure Data Lake Storage

Azure Data Lake Storage supports authentication via Access Key, Shared Access Signature (SAS), Microsoft Entra ID user, Microsoft Entra service principal, or Managed identities for Azure resources.

Access Key

To authenticate with an Azure Access key, set these connection properties:

AuthScheme: AccessKey.
AzureAccessKey: The storage key associated with your Azure Data Lake Storage account.

Shared Access Signature (SAS)

To authenticate with a Shared Access Signature (SAS), you must first generate the SAS at the Azure Portal:

Sign into the Azure Portal (https://portal.azure.com/) with your root account credentials.
Click Storage accounts and select the storage account you want to use.
Under Security + networking, click Shared access signature.
Set any required permissions.
Specify a time when you want the token to expire.
To generate the shared access signature, click Generate SAS and connection string.
When the SAS has been generated, copy it.

Once you have obtained the SAS, set these connection properties:

AuthScheme: AzureStorageSAS.
AzureSharedAccessSignature: The SAS associated with your Azure Blob Storage account, which you just generated.

Microsoft Entra ID User

Microsoft Entra ID User authentication supports connection via a desktop application, a web application, or a headless machine. In all cases, you must set AuthScheme to Microsoft Entra ID.

Desktop Applications

The connector provides an embedded OAuth application that simplifies OAuth desktop Authentication. You can also choose to connect via a custom OAuth application, which provides further flexibility.

For further information,see Creating a Custom OAuth App.

Get and Refresh the OAuth Access Token

Build your connection string using the following connection properties:

InitiateOAuth: GETANDREFRESH. This property enables you to use InitiateOAuth, which eliminates the need to repeat the OAuth exchange and manually re-set the OAuthAccessToken.
OAuthClientId (custom applications only): The client ID that was assigned when you registered your custom application.
OAuthClientSecret (custom applications only): The client secret that was assigned when you registered your custom application.
CallbackURL (custom application only): The redirect URI you defined when you registered your custom application. For example: http://localhost:33333

When you connect, the connector opens the Microsoft identity platform's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

The connector obtains an access token from the Microsoft identity platform and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Microsoft Entra service principal

Authentication as a Microsoft Entra service principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself.

All tasks taken by the application are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For Microsoft Entra service principal authentication, set AuthScheme to AzureServicePrincipal.

Creating an Microsoft Entra ID App and a Microsoft Entra service principal

If you will authenticate using a Microsoft Entra service principal, you must first create and register a Microsoft Entra ID application with a Microsoft Entra ID tenant, as described in Creating an Entra ID (Microsoft Entra ID) Application.

In portal.azure.com, navigate to App Registration > API Permissions. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under Application Permissions.

Assigning a role to the application

To access resources in your subscription, you must assign an appropriate role to the custom Microsoft Entra ID application. Do the following:

Use the search bar to locate the Subscriptions service.
Open the Subscriptions page.
Select the subscription to which to assign the application.
Open Access control (IAM) and select Add > Add role assignment. The Add role assignment page opens.
Assign your custom Microsoft Entra ID application the Owner role.

Setting the connection properties

The connection properties you set to connect with your custom Microsoft Entra ID application will vary, depending on whether you want to authenticate using a Client Secret or a Certificate.

After you connect, authentication with client credentials takes place automatically like any other connection, except that no window opens to prompt the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Client Secret Connection Properties

AuthScheme: AzureServicePrincipal.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthClientId: The client ID in your custom Microsoft Entra ID application settings.
OAuthClientSecret: The client secret in your custom Microsoft Entra ID application settings.

Certificate Connection Properties

AuthScheme: AzureServicePrincipalCert.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthJWTCert: The JWT Certificate store.
OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.
OAuthJWTIssuer: The issuer of the Java Web Token.

Note

In most cases, OAuthJWTIssuer takes the value of the OAuthClientId property and does not need to be individually set.

Managed identities for Azure resources

If you are connecting from an Azure VM with permissions for Azure Data Lake Storage, set AuthScheme to AzureMSI.

Create a Custom OAuth App

Create a Custom Microsoft Entra ID Application

Connecting to Azure Data Lake Storage via a Web application requires the creation of a custom app registration.

If you are connecting via a Desktop application or a Headless machine, you can use the embedded OAuth Application Credentials with branding that ship with Jitterbit Connector for Microsoft Excel. However, you can also connect using a custom app registration. Custom app registrations may be useful if you want to:

control branding of the Authentication Dialog;
control the redirect URI that the application redirects the user to after the user authenticates; or
customize the permissions that you are requesting from the user.

How to Authenticate Using a Custom Microsoft Entra ID Application

To authenticate using a custom app registration, you register a single custom application in the Microsoft Entra ID portal.

You can then use this custom application in either of the following ways:

To authenticate as a signed-in user (user-based authentication), use the Microsoft Entra ID authentication scheme (AuthScheme=Microsoft Entra ID).
To authenticate as the application itself, without a user, (application-based authentication), you must create a service principal from the same registration and use the AzureServicePrincipal authentication scheme (AuthScheme=AzureServicePrincipal.

Both of these types of authentication are OAuth-based.

Before You Begin

The custom applications you create for use with Azure Data Lake Storage must be assigned specific roles.

Assigning Azure Roles

The individual assigning Azure roles must have Microsoft.Authorization/roleAssignments/write permission, which is included in the following roles:

Role Based Access Control Administrator
User Access Administrator

Microsoft Entra ID Authentication Roles

The delegating user must be assigned these roles:

Storage Blob Data Owner
Storage Blob Data Contributor

Microsoft Entra service principal authentication Roles

The custom Service Principal application must be assigned these roles:

Storage Blob Data Owner
Storage Blob Data Contributor

Checking Current Access

To check access for users or custom applications, log in to the Azure Portal and navigate to Subscriptions > Access control (IAM) > Check access.

In the Check Access screen, search by the name of the user or application. The portal displays that user or application's current role assignments.

Create a Custom Microsoft Entra ID Application

You can use a custom app registration by itself, to authenticate as a signed-in user, or use it with a Microsoft Entra service principal to authenticate as the application itself.

To create the custom app registration and obtain your custom application's OAuthClientId and OAuthClientSecret, do the following:

Log in to https://portal.azure.com.
In the left-hand navigation pane, select All services. Filter and select App registrations.
Click New registrations.
Enter an application name and select the desired tenant setup.

When creating a custom app registration in Microsoft Entra ID, you can define whether the application is single- or multi-tenant. If you select the default option, "Accounts in this organizational directory only", when establishing a connection with Microsoft Excel you must set the AzureTenant connection property to the ID of the Microsoft Entra ID Tenant. Otherwise, the authentication attempt fails with an error.
If your application is for private use only, "Accounts in this organization directory only" should be sufficient. Otherwise, if you want to distribute your application, choose one of the multi-tenant options.
Either set the redirect URL to http://localhost:33333, the connector's default, or specify a different port and set CallbackURL to the exact reply URL you defined.
Click Register to register the new application. This opens an application management screen.
Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
Navigate to "Certificates & Secrets" and define the application authentication type. There are two types of authentication available: using a client secret or a certificate. The recommended authentication method is using a certificate.
- Option 1: Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
- Option 2: Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will need it as the OAuthClientSecret.
Select API Permissions > Add. If your application connects without a user context, select Application Permissions. If your application authenticates on behalf of a signed-in user, choose Delegated permissions.
Save your changes.
If you have selected to use permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page. Otherwise, follow the steps under "Admin Consent".

Create an Microsoft Entra ID Service Principal Application

When authenticating using a Microsoft Entra service principal, you must create both a custom app registration and a Microsoft Entra service principal that can access the necessary resources. After you have created the custom app registration, follow these steps to create the Microsoft Entra service principal:

Log in to https://portal.azure.com.
In the left-hand navigation pane, select All services. Filter and select App registrations.
Click New registrations.
Enter an app name and select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant). Then set the redirect URL to http://localhost:33333, the connector's default.
After creating the application, copy the Application (client) ID value displayed in the "Overview" section. This value is used as the OAuthClientId
Define the app authentication type by going to the "Certificates & Secrets" section. There are two types of authentication available: using a client secret and using a certificate. The recommended authentication method is via a certificate.
- Option 1: Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
- Option 2: Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will use it as the OAuthClientSecret.
On the Authentication tab, make sure to select Access tokens (used for implicit flows).

Connect to Box

Use the OAuth authentication standard to connect to Box. You can authenticate with a user account or with a service account. A service account is required to grant organization-wide access scopes to the connector. The connector facilitates these authentication flows as described below.

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows.

Desktop Applications

The connector provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Create a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId (custom applications only): Set this to the client ID assigned when you registered your app.
OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.
CallbackURL (custom application only): Set this to the redirect URI defined when you registered your app. For example: http://localhost:33333

When you connect, the connector opens Box's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

The connector obtains an access token from Box and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Authenticate with a Service Account

Set the AuthScheme to OAuthJWT to authenticate with this method.

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the connector.

You need to create an OAuth application in this flow. See Create a Custom OAuth App to create and authorize an app. You can then connect to Box data that the service account has permission to access.

After setting the following connection properties, you are ready to connect:

InitiateOAuth: Set to GETANDREFRESH.
OAuthClientId: Set to the Client ID in your app settings.
OAuthClientSecret: Set to the Client Secret in your app settings.
OAuthJWTCertType: Set to "PEMKEY_FILE".
OAuthJWTCert: Set to the path to the .pem file you generated.
OAuthJWTCertPassword: Set to the password of the .pem file.
OAuthJWTCertSubject: Set to "*" to pick the first certificate in the certificate store.
OAuthJWTSubjectType: Set to "enterprise" or "user" depending on the Application Access Value you selected in your app settings. The default value of this connection property is "enterprise".
OAuthJWTSubject: Set to your enterprise ID if your subject type is set to "enterprise" or your app user ID if your subject type is set to "user".
OAuthJWTPublicKeyId: Set to the ID of your public key in your app settings.

When you connect the connector completes the OAuth flow for a service account.

Creates and signs the JWT with the claim set required by the connector.
Exchanges the JWT for the access token.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Submits the JWT for a new access token when the token expires.

Create a Custom OAuth App

Create a Custom OAuth Application

The connector embeds OAuth Application Credentials with branding that can be used when connecting via a desktop application.

You may choose to use your own OAuth Application Credentials when you want to:

control branding of the authentication dialog
control the redirect URI that the application redirects the user to after the user authenticates
customize the permissions that you are requesting from the user

Procedure

This procedure creates a custom OAuth application, registers that application, and generates values that are used to configure the OAuthClientId and OAuthClientSecret.

At the Box Enterprise Developer Console:

Log in to your Box developers dashboard.
Click Create New App.
Specify basic application information, as appropriate.
Specify your application type (e.g., Custom App).
Select the User Authentication (OAuth 2.0) authentication method.
Set the Redirect URI:
- If this is a desktop application , set the Redirect URI to http://localhost:33333 or a different port number.
Click Create App.
The next task is to create a public and private key pair.
- To create a keypair from the Developer Console:
  1. Navigate to the Developer Console Configuration tab.
  2. Scroll down to Add and Manage Public Keys.
  3. Click Generate a Public/Private Keypair. Box creates a keypair in a JSON file,
    
    and downloads that file to your desktop. You can then move that file to your application code.

Note

Box does not back up private keys for security reasons. Be careful to back up the Public/Private JSON file. If you lose your private key, you must reset the entire keypair. - To add a keypair manually: 1. Open a terminal window and run the following OpenSSL commands:

    ```
    openssl genrsa -des3 -out private.pem 2048

    openssl rsa -in private.pem -outform PEM -pubout -out public.pem
    ```

Note

To run OpenSSL in a Windows environment, install the Cygwin package.

2.  At the Developer Console, navigate to the configuration tab for the Custom OAuth application you just created.

3.  Scroll down to **`Add and Manage Public Keys`**.

4.  Click **`Add a Public Key`**.

5.  Click **`Verify and Save`**.

Before the custom application can be used, a Box Admin must authorize it within the Box Admin Console.
1. Navigate to your application within the Developer Console.
2. Click the Authorization tab.
3. At the prompt to Submit app for authorization for access to the Enterprise, click Review and Submit.
  
  Your Box Enterprise Admin approves the application. 10. Finally, select the scope of user permissions your custom OAuth application must request.

After your application is created and registered, click Configuration from the main menu to access your settings. Note the displayed Redirect URI, Client ID, and Client Secret. You will need these values later.

When JWT Access Scopes Change

If you change the JWT access scopes, you must reauthorize the application in the enterprise admin console:

Click Apps in the main manu.
Select the ellipsis button next to your JWT application name.
Select Reauthorize App in the menu.

Connect to Dropbox

Dropbox uses the OAuth authentication standard.

Dropbox OAuth Scopes

You need to choose between using 's embedded OAuth app or Create a Custom OAuth App.

The embedded app includes the following scopes:

account_info.read
file_requests.read
files.content.read
files.content.write
files.metadata.read
sharing.read
sharing.write

Desktop Applications

The connector provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Create a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId (custom applications only): Set this to the client ID assigned when you registered your app.
OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.
CallbackURL (custom application only): Set this to the redirect URI defined when you registered your app. For example: http://localhost:33333

When you connect, the connector opens Dropbox's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

The connector obtains an access token from Dropbox and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Create a Custom OAuth App

When To Create a Custom OAuth Application

The connector embeds OAuth Application Credentials with branding that can be used when connecting via a desktop application.

You may choose to use your own OAuth Application Credentials when you want to:

control branding of the Authentication Dialog
control the redirect URI that the application redirects the user to after the user authenticates
customize the permissions that you are requesting from the user

Create a Custom OAuth App

Log in to your Dropbox developers dashboard and click Create New App. Select the Dropbox API type. Select the Full Dropbox access for your app.
After creating your app, you can view Configuration from the main menu that displays your app settings.
On the app Settings tab, note the values of App key and App secret for later connector configuration.
Set the Redirect URI and store the specified value for later connector configuration.
- When setting up a desktop app , set the Redirect URI to http://localhost:33333 or a different port number.
On the app Permissions tab, select the scope of user permissions your app will request.

No further values need to be specified in the Microsoft Excel app settings.

Connect to Google Cloud Storage

Set the ProjectId property to the ID of the project you want to connect to.

Authenticate to Google Cloud Storage

The connector supports using user accounts, service accounts and GCP instance accounts for authentication.

The following sections discuss the available authentication schemes for Google Cloud Storage:

User Accounts (OAuth)
Service Account (OAuthJWT)
GCP Instance Account

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows.

Web Applications

When connecting via a Web application, you need to create and register a custom OAuth application with Google Cloud Storage. You can then use the connector to acquire and manage the OAuth token values. See Create a Custom OAuth App for more information about custom applications.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: Set this to the Client ID in your application settings.
OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the Callback URL you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in to the custom OAuth application and authorize the web application. Once authenticated, the browser redirects you to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL.

Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the Client ID in your application settings.
OAuthClientSecret: Set this to the Client Secret in your application settings.
OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
OAuthSettingsLocation: Set this to the location where the connector saves the OAuth token values, which persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

OAuthClientId: Set this to the Client ID in your application settings.
OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver, use OAuth with a user account on a headless machine. You need to authenticate on another device that has an internet browser.

Choose one of two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.
Then configure the connector to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- If you are using the Embedded OAuth Application click Google Cloud Storage OAuth endpoint to open the endpoint in your browser.
- If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client ID assigned when you registered your application.
  - OAuthClientSecret: Set to the client secret assigned when you registered your application.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser. 2. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code. 3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

InitiateOAuth: Set this to REFRESH.
OAuthVerifier: Set this to the verifier code.
OAuthClientId: (custom applications only) Set this to the Client ID in your custom OAuth application settings.
OAuthClientSecret: (custom applications only) Set this to the Client Secret in the custom OAuth application settings.
OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client ID assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client ID assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Service Accounts (OAuthJWT)

To authenticate using a service account, you must create a new service account and have a copy of the accounts certificate. If you do not already have a service account, you can create one by following the procedure in Create a Custom OAuth App.

For a JSON file, set these properties:

AuthScheme: Set this to OAuthJWT.
InitiateOAuth: Set this to GETANDREFRESH.
OAuthJWTCertType: Set this to GOOGLEJSON.
OAuthJWTCert: Set this to the path to the .json file provided by Google.
OAuthJWTSubject: (optional) Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

For a PFX file, set these properties instead:

AuthScheme: Set this to OAuthJWT.
InitiateOAuth: Set this to GETANDREFRESH.
OAuthJWTCertType: Set this to PFXFILE.
OAuthJWTCert: Set this to the path to the .pfx file provided by Google.
OAuthJWTCertPassword: (optional) Set this to the .pfx file password. In most cases you must provide this since Google encrypts PFX certificates.
OAuthJWTCertSubject: (optional) Set this only if you are using a OAuthJWTCertType which stores multiple certificates. Should not be set for PFX certificates generated by Google.
OAuthJWTIssuer: Set this to the email address of the service account. This address will usually include the domain iam.gserviceaccount.com.
OAuthJWTSubject: (optional) Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

GCP Instance Accounts

When running on a GCP virtual machine, the connector can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

Create a Custom OAuth App

Create a Custom OAuth Application

The connector embeds OAuth Application Credentials with branding that can be used when connecting to Microsoft Excel via a desktop application or a headless machine.

(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Microsoft Excel".)

However, you must create a custom OAuth application to connect to Microsoft Excel via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

control branding of the authentication dialog
control the redirect URI that the application redirects the user to after the user authenticates
customize the permissions that you are requesting from the user

The following sections describe how to enable the Directory API and create custom OAuth applications for user accounts (OAuth) and Service Accounts (OAuth/JWT).

Enable the Cloud Storage API

Follow these steps to enable the Cloud Storage API:

Navigate to the Google Cloud Console.
Select Library from the left-hand navigation menu. This opens the Library page.
In the search field, enter "Cloud Storage API" and select Cloud Storage API from the search results.
On the Cloud Storage API page, click ENABLE.

Create an OAuth Application

To create custom OAuth applications that retrieve the necessary OAuth connection properties, follow these procedures.

User Accounts (OAuth)

For users whose AuthScheme is OAuth and who need to authenticate over a web application, you must always create a custom OAuth application. (For desktop and headless flows, creating a custom OAuth application is optional.)

Do the following:

Navigate to the Google Cloud Console.
Create a new project or select an existing project.
At the left-hand navigation menu, select Credentials.
If this project does not already have a consent screen configured, click CONFIGURE CONSENT SCREEN to create one. If you are not using a Google Workspace account, you are restricted to creating an External-type Consent Screen, which requires specifying a support email and developer contact email. Additional info is optional.
On the Credentials page, select Create Credentials > OAuth Client ID.
In the Application Type menu, select Web application.
Specify a name for your custom OAuth application.
Under Authorized redirect URIs, click ADD URI and enter a redirect URI.
Click Enter, then CREATE. The Cloud Console returns you to the Credentials page.
A window opens that displays your client ID and client secret.
Record the client ID and Client Secret for later use as the OAuthClientId and OAuthClientSecret connection properties.

Note

The client secret remains accessible from from the Google Cloud Console.

Service Accounts (OAuthJWT)

Service accounts (AuthScheme OAuthJWT) can be used in an OAuth flow to access Google APIs on behalf of users in a domain. A domain administrator can delegate domain-wide access to the service account.

To create a new service account:

Navigate to the Google Cloud Console.
Create a new project or select an existing project.
At the left-hand navigation menu, select Credentials.
Select Create Credentials > Service account.
On the Create service account page, enter the service account name, ID, and an optional description.
Click DONE. The Cloud Console redisplays the Credentials page.
In the Service Accounts section, select the service account you just created.
Click the Advanced Settings section and enable Domain-Wide Delegation.
Record the Client ID shown for domain-wide delegation. You'll use this in the Admin Console.
In a new tab, navigate to the Google Admin Console.
Go to Security > API Controls > Domain-Wide Delegation.
Click Manage Domain-Wide Delegation, then Add new.
Enter the recorded Client ID and the list of required scopes.
Back in the Cloud Console, select the KEYS tab for the service account.
Click ADD KEY > Create new key.
Select a supported key type (see OAuthJWTCert and OAuthJWTCertType).
Click CREATE. The key is automatically downloaded to your device.
Record the additional information for later use.

In the service account flow, the connector exchanges a JSON Web Token (JWT) for the OAuthAccessToken. The private key downloaded in the steps above is used to sign the JWT. The connector inherits the permissions granted to the service account, including any scopes configured through domain-wide delegation.

Connect to Google Drive

Authenticate to Google Drive

The connector supports using user accounts, service accounts and GCP instance accounts for authentication.

The following sections discuss the available authentication schemes for Google Drive:

User Accounts (OAuth)
Service Account (OAuthJWT)
GCP Instance Account

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows.

Desktop Applications

The connector provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Create a Custom OAuth App for information about creating custom applications and reasons for doing so.

For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications.

After setting the following connection properties, you are ready to connect:

InitiateOAuth: Set this to GETANDREFRESH, which instructs the connector to automatically attempt to get and refresh the OAuth access token.
OAuthClientId: (custom applications only) Set this to the Client ID in your custom OAuth application settings.
OAuthClientSecret: (custom applications only) Set this to the Client Secret in the custom OAuth application settings.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process as follows:

Extracts the access token from the callback URL.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation that persist across connections.

Service Accounts (OAuthJWT)

To authenticate using a service account, you must create a new service account and have a copy of the accounts certificate. If you do not already have a service account, you can create one by following the procedure in Create a Custom OAuth App.

For a JSON file, set these properties:

AuthScheme: Set this to OAuthJWT.
InitiateOAuth: Set this to GETANDREFRESH.
OAuthJWTCertType: Set this to GOOGLEJSON.
OAuthJWTCert: Set this to the path to the .json file provided by Google.
OAuthJWTSubject: (optional) Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

For a PFX file, set these properties instead:

AuthScheme: Set this to OAuthJWT.
InitiateOAuth: Set this to GETANDREFRESH.
OAuthJWTCertType: Set this to PFXFILE.
OAuthJWTCert: Set this to the path to the .pfx file provided by Google.
OAuthJWTCertPassword: (optional) Set this to the .pfx file password. In most cases you must provide this since Google encrypts PFX certificates.
OAuthJWTCertSubject: (optional) Set this only if you are using a OAuthJWTCertType which stores multiple certificates. Should not be set for PFX certificates generated by Google.
OAuthJWTIssuer: Set this to the email address of the service account. This address will usually include the domain iam.gserviceaccount.com.
OAuthJWTSubject: (optional) Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

GCP Instance Accounts

When running on a GCP virtual machine, the connector can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

Create a Custom OAuth App

Create a Custom OAuth Application

The connector embeds OAuth Application Credentials with branding that can be used when connecting to Microsoft Excel via a desktop application or a headless machine.

(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Microsoft Excel".)

However, you must create a custom OAuth application to connect to Microsoft Excel via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

control branding of the authentication dialog
control the redirect URI that the application redirects the user to after the user authenticates
customize the permissions that you are requesting from the user

The following sections describe how to enable the Directory API and create custom OAuth applications for user accounts (OAuth) and Service Accounts (OAuth/JWT).

Enable the Google Drive API

Follow these steps to enable the Google Drive API:

Navigate to the Google Cloud Console.
Select Library from the left-hand navigation menu. This opens the Library page.
In the search field, enter "Google Drive API" and select Google Drive API from the search results.
On the Google Drive API page, click ENABLE.

Create an OAuth Application

To create custom OAuth applications that retrieve the necessary OAuth connection properties, follow these procedures.

User Accounts (OAuth)

For users whose AuthScheme is OAuth and who need to authenticate over a web application, you must always create a custom OAuth application. (For desktop and headless flows, creating a custom OAuth application is optional.)

Do the following:

Navigate to the Google Cloud Console.
Create a new project or select an existing project.
At the left-hand navigation menu, select Credentials.
If this project does not already have a consent screen configured, click CONFIGURE CONSENT SCREEN to create one. If you are not using a Google Workspace account, you are restricted to creating an External-type Consent Screen, which requires specifying a support email and developer contact email. Additional info is optional.
On the Credentials page, select Create Credentials > OAuth Client ID.
In the Application Type menu, select Web application.
Specify a name for your custom OAuth application.
Under Authorized redirect URIs, click ADD URI and enter a redirect URI.
Click Enter, then CREATE. The Cloud Console returns you to the Credentials page.
A window opens that displays your client ID and client secret.
Record the client ID and Client Secret for later use as the OAuthClientId and OAuthClientSecret connection properties.

Note

The client secret remains accessible from from the Google Cloud Console.

Service Accounts (OAuthJWT)

Service accounts (AuthScheme OAuthJWT) can be used in an OAuth flow to access Google APIs on behalf of users in a domain. A domain administrator can delegate domain-wide access to the service account.

To create a new service account:

Navigate to the Google Cloud Console.
Create a new project or select an existing project.
At the left-hand navigation menu, select Credentials.
Select Create Credentials > Service account.
On the Create service account page, enter the service account name, ID, and an optional description.
Click DONE. The Cloud Console redisplays the Credentials page.
In the Service Accounts section, select the service account you just created.
Click the Advanced Settings section and enable Domain-Wide Delegation.
Record the Client ID shown for domain-wide delegation. You'll use this in the Admin Console.
In a new tab, navigate to the Google Admin Console.
Go to Security > API Controls > Domain-Wide Delegation.
Click Manage Domain-Wide Delegation, then Add new.
Enter the recorded Client ID and the list of required scopes.
Back in the Cloud Console, select the KEYS tab for the service account.
Click ADD KEY > Create new key.
Select a supported key type (see OAuthJWTCert and OAuthJWTCertType).
Click CREATE. The key is automatically downloaded to your device.
Record the additional information for later use.

In the service account flow, the connector exchanges a JSON Web Token (JWT) for the OAuthAccessToken. The private key downloaded in the steps above is used to sign the JWT. The connector inherits the permissions granted to the service account, including any scopes configured through domain-wide delegation.

Connect to HTTP Streams

Authenticate to HTTP(S)

The connector generically supports connecting to Microsoft Excel data stored on HTTP(S) streams.

Several authentication methods, such as user/password, digest access, OAuth, OAuthJWT, and OAuth PASSWORD flow are supported.

You can also connect to streams that have no authentication set up.

No Authentication

Connect to an HTTP(S) stream with no authentication by setting the AuthScheme connection property to None.

Basic

Set the following to connect:

AuthScheme: Set this to Basic.
User: Set this to the username associated with your HTTP(S) stream.
Password: Set this to the password associated with your HTTP(S) stream.

Digest

Set the following to connect:

AuthScheme: Set this to Digest.
User: Set this to the username associated with your HTTP(S) stream.
Password: Set this to the password associated with your HTTP(S) stream.

OAuth

Set the AuthScheme to OAuth.

OAuth requires the authenticating user to interact with Microsoft Excel using the browser. The connector facilitates this in various ways as described in the following sections.

Before following the procedures below, you need to register an OAuth app with the service containing the Microsoft Excel data you want to work with.

Creating a custom application in most services requires registering as a developer and creating an app in the UI of the service.

This is not necessarily true for all services. In some you must contact the service provider to create the app for you. However it is done, you must obtain the values for OAuthClientId, OAuthClientSecret, and CallbackURL.

Desktop Applications

After setting the following connection properties, you are ready to connect:

OAuthVersion: Set this to the OAuth Version, either 1.0 or 2.0.
OAuthRequestTokenURL: Required for OAuth 1.0. In OAuth 1.0, this is the URL where the app makes a request for the request token.
OAuthAuthorizationURL: Required for OAuth 1.0 and 2.0. This is the URL where the user logs into the service and grants permissions to the application. In OAuth 1.0, if permissions are granted, the request token is authorized.
OAuthAccessTokenURL: Required for OAuth 1.0 and 2.0. This is the URL where the request for the access token is made. In OAuth 1.0, the authorized request token is exchanged for the access token.
OAuthRefreshTokenURL: Required for OAuth 2.0. In OAuth 2.0, this is the URL where the refresh token is exchanged for a new access token when the old one expires. Note that for your data source this may be the same as the access token URL.
OAuthClientId: Set this to the client ID in your app settings. This may also be called the consumer key.
OAuthClientSecret: Set this to the client secret in your app settings. This may also be called the consumer secret.
CallbackURL: Set this to http://localhost:33333. If you specified a redirect URL in your app settings, this must match.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the access token in the connection string.

When you connect, the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

Extracts the access token from the callback URL and authenticates requests.
Refreshes the access token when it expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

OAuth JWT

Set AuthScheme to OAuthJWT.

The connector supports using JWT as an authorization grant in situations where a user cannot perform an interactive sign-on. After setting the following connection properties, you are ready to connect:

OAuthVersion: Set this to 2.0.
OAuthAccessTokenURL: Set this to the URL where the JWT is exchanged for an access token.
OAuthJWTCert: Set this to the certificate you want to use. In most cases this will be a path to a PEM or PFX file.
OAuthJWTCertType: Set this to the correct certificate type. In most cases this will either PEMKEY_FILE or PFXFILE.
OAuthJWTCertPassword: If the certificate is encrypted, set this to the encryption password.
OAuthJWTIssuer: Set this to the issuer. This corresponds to the iss field in the JWT.
InitiateOAuth: Set this to GETANDREFRESH.

Note that the JWT signature algorithm cannot be set directly. The connector only supports the RS256 algorithm.

The connector will then construct a JWT including the following fields, and submit it to OAuthAccessTokenURL for an access token.

scope This will come from Scope if it is provided.
aud This will come from OAuthJWTAudience if it is provided.
iss This will come from OAuthJWTIssuer.
iat This is the time when the JWT is generated.
exp This is the value of iat plus the value of OAuthJWTValidityTime.
sub This will come from OAuthJWTSubject if it is provided.

OAuthPassword

AuthScheme: Set this to OAuthPassword.

OAuth requires the authenticating user to interact with Microsoft Excel using the browser. The connector facilitates this in various ways as described in the following sections.

Before following the procedures below, you need to register an OAuth app with the service containing the Microsoft Excel data you want to work with.

Creating a custom application in most services requires registering as a developer and creating an app in the UI of the service.

This is not necessarily true for all services. In some you must contact the service provider to create the app for you. However it is done, you must obtain the values for OAuthClientId, OAuthClientSecret, and CallbackURL.

After setting the following connection properties, you are ready to connect:

OAuthVersion: Set this to the OAuth Version, either 1.0 or 2.0.
OAuthRequestTokenURL: Required for OAuth 1.0. In OAuth 1.0, this is the URL where the app makes a request for the request token.
OAuthAuthorizationURL: Required for OAuth 1.0 and 2.0. This is the URL where the user logs into the service and grants permissions to the application. In OAuth 1.0, if permissions are granted, the request token is authorized.
OAuthAccessTokenURL: Required for OAuth 1.0 and 2.0. This is the URL where the request for the access token is made. In OAuth 1.0, the authorized request token is exchanged for the access token.
OAuthRefreshTokenURL: Required for OAuth 2.0. In OAuth 2.0, this is the URL where the refresh token is exchanged for a new access token when the old one expires. Note that for your data source this may be the same as the access token URL.
OAuthClientId: Set this to the client ID in your app settings. This may also be called the consumer key.
OAuthClientSecret: Set this to the client secret in your app settings. This may also be called the consumer secret.
CallbackURL: Set this to http://localhost:33333. If you specified a redirect URL in your app settings, this must match.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the access token in the connection string.

When you connect, the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

Extracts the access token from the callback URL and authenticates requests.
Refreshes the access token when it expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Connect to IBM Object Storage

Before You Connect

Register a New Instance of Cloud Object Storage

If you do not already have Cloud Object Storage in your IBM Cloud account, you can follow the procedure below to install an instance of SQL Query in your account:

Log in to your IBM Cloud account.
Navigate to the Cloud Object Storage page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

API Key

To connect with IBM Cloud Object Storage, you will need an ApiKey. You can obtain this as follows:

Log in to your IBM Cloud account.
Navigate to the Platform API Keys page.
On the middle-right corner click Create an IBM Cloud API Key to create a new API Key.
In the pop-up window, specify the API Key name and click Create. Note the ApiKey as you can never access it again from the dashboard.

Connect to IBM Cloud Object Storage

Set Region to to your IBM instance region.

Authenticate to IBM Cloud Object Storage

You can authenticate to IBM Cloud Object Storage using either IAMSecretKey, or OAuth authentication.

IAMSecretKey

Set the following properties to authenticate:

AccessKey: Set this to an IBM Access Key (a username).
SecretKey: Set this to an IBM Secret Key.

For example:

ConnectionType=IBM Object Storage Source;URI=ibmobjectstorage://bucket1/folder1; AccessKey=token1; SecretKey=secret1; Region=eu-gb;

OAuth

Set the following to authenticate using OAuth authentication.

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AuthScheme: Set this to OAuth.
ApiKey: Set this to the IBM API Key noted during setup.

For example:

ConnectionType=IBM Object Storage Source;URI=ibmobjectstorage://bucket1/folder1; ApiKey=key1; Region=eu-gb; AuthScheme=OAuth; InitiateOAuth=GETANDREFRESH;

When you connect, the connector completes the OAuth process.

Extracts the access token and authenticates requests.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Connect to OneDrive

You can connect to OneDrive using an Microsoft Entra ID user, with MSI authentication, or using a Microsoft Entra service principal.

Microsoft Entra ID Users

AuthScheme must be set to Microsoft Entra ID in all user account flows.

Desktop Applications

The connector provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId (custom applications only): Set this to the client ID assigned when you registered your app.
OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.
CallbackURL (custom application only): Set this to the redirect URI defined when you registered your app. For example: http://localhost:33333

When you connect, the connector opens the Microsoft identity platform's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

The connector obtains an access token from the Microsoft identity platform and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Microsoft Entra service principal

Authentication as a Microsoft Entra service principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself.

All tasks taken by the application are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For Microsoft Entra service principal authentication, set AuthScheme to AzureServicePrincipal.

Creating an Microsoft Entra ID App and a Microsoft Entra service principal

If you will authenticate using a Microsoft Entra service principal, you must first create and register a Microsoft Entra ID application with a Microsoft Entra ID tenant, as described in Creating an Entra ID (Microsoft Entra ID) Application.

In portal.azure.com, navigate to App Registration > API Permissions. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under Application Permissions.

Assigning a role to the application

To access resources in your subscription, you must assign an appropriate role to the custom Microsoft Entra ID application. Do the following:

Use the search bar to locate the Subscriptions service.
Open the Subscriptions page.
Select the subscription to which to assign the application.
Open Access control (IAM) and select Add > Add role assignment. The Add role assignment page opens.
Assign your custom Microsoft Entra ID application the Owner role.

Setting the connection properties

The connection properties you set to connect with your custom Microsoft Entra ID application will vary, depending on whether you want to authenticate using a Client Secret or a Certificate.

After you connect, authentication with client credentials takes place automatically like any other connection, except that no window opens to prompt the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Client Secret Connection Properties

AuthScheme: AzureServicePrincipal.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthClientId: The client ID in your custom Microsoft Entra ID application settings.
OAuthClientSecret: The client secret in your custom Microsoft Entra ID application settings.

Certificate Connection Properties

AuthScheme: AzureServicePrincipalCert.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthJWTCert: The JWT Certificate store.
OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.
OAuthJWTIssuer: The issuer of the Java Web Token.

Note

In most cases, OAuthJWTIssuer takes the value of the OAuthClientId property and does not need to be individually set.

Managed identities for Azure resources

If you are connecting from an Azure VM with permissions for Azure Data Lake Storage, set AuthScheme to AzureMSI.

Create a Custom OAuth App

There are two types of custom app registrations: Microsoft Entra ID and Microsoft Entra ID with a Microsoft Entra service principal. Both are OAuth-based.

When to Create a Custom Application

The connector embeds OAuth Application Credentials with branding that can be used when connecting via either a Desktop Application or from a Headless Machine.

You may choose to use your own Microsoft Entra ID Application Credentials when you want to:

control branding of the Authentication Dialog
control the redirect URI that the application redirects the user to after the user authenticates
customize the permissions that you are requesting from the user

Custom Microsoft Entra ID Applications

You can use a custom app registration to authenticate a service account or a user account. You can always create a custom app registration, but note that desktop and headless connections support embedded OAuth, which simplifies the process of authentication. See "Establishing a Connection" for information about using the embedded OAuth application.

Create a Custom Microsoft Entra ID App

Follow the steps below to obtain the Microsoft Entra ID values for your application, the OAuthClientId and OAuthClientSecret.

Log in to https://portal.azure.com.
In the left-hand navigation pane, select All services. Filter and select App registrations.
Click New registrations.
Enter an application name and select the desired tenant setup.

When creating a custom app registration in Microsoft Entra ID, you can define whether the application is single- or multi-tenant. If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Microsoft Entra ID Tenant when establishing a connection with the Jitterbit Connector for Microsoft Excel. Otherwise, the authentication attempt fails with an error. If your application is for private use only, "Accounts in this organization directory only" should be sufficient. Otherwise, if you want to distribute your application, choose one of the multi-tenant options.
Set the redirect URL to http://localhost:33333, the connector's default. Or, specify a different port and set CallbackURL to the exact reply URL you defined.
Click Register to register the new application. This opens an application management screen. Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
Navigate to the "Certificates & Secrets" and define the application authentication type. There are two types of authentication available: using a client secret or a certificate. The recommended authentication method is using a certificate.
- Option 1: Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
- Option 2: Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will need it as the OAuthClientSecret.
Select API Permissions > Add. If your application connects without a user context, select Application Permissions. If your application authenticates on behalf of a signed-in user, choose Delegated permissions.
Save your changes.
If you have selected to use permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page. Otherwise, follow the steps under "Admin Consent".

Custom Microsoft Entra ID Service Principal Applications

When authenticating using a Microsoft Entra service principal, you must create both a custom app registration and a service principal that can access the necessary resources. Follow the steps below to create a custom app registration and obtain the connection properties for Microsoft Entra service principal authentication.

Create a Custom Microsoft Entra ID App with a Microsoft Entra service principal

Follow the steps below to obtain the Microsoft Entra ID values for your application.

Log in to https://portal.azure.com.
In the left-hand navigation pane, select All services. Filter and select App registrations.
Click New registrations.
Enter an app name and select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant). Then set the redirect URL to http://localhost:33333, the connector's default.
After creating the application, copy the Application (client) ID value displayed in the "Overview" section. This value is used as the OAuthClientId
Define the app authentication type by going to the "Certificates & Secrets" section. There are two types of authentication available: using a client secret and using a certificate. The recommended authentication method is via a certificate.
- Option 1 - Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
- Option 2 - Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will use it as the OAuthClientSecret.
On the Authentication tab, make sure to select Access tokens (used for implicit flows).

Connect to OneLake

Authenticate to OneLake

You can authenticate to OneLake via Microsoft Entra ID user, Managed identities for Azure resources, or Microsoft Entra service principal.

Microsoft Entra ID User

AuthScheme must be set to Microsoft Entra ID in all user account flows.

Desktop Applications

The connector provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId (custom applications only): Set this to the client ID assigned when you registered your app.
OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.
CallbackURL (custom application only): Set this to the redirect URI defined when you registered your app. For example: http://localhost:33333

When you connect, the connector opens the Microsoft identity platform's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

The connector obtains an access token from the Microsoft identity platform and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Microsoft Entra service principal

Authentication as a Microsoft Entra service principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself.

All tasks taken by the application are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For Microsoft Entra service principal authentication, set AuthScheme to AzureServicePrincipal.

Creating an Microsoft Entra ID App and a Microsoft Entra service principal

If you will authenticate using a Microsoft Entra service principal, you must first create and register a Microsoft Entra ID application with a Microsoft Entra ID tenant, as described in Creating an Entra ID (Microsoft Entra ID) Application.

In portal.azure.com, navigate to App Registration > API Permissions. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under Application Permissions.

Assigning a role to the application

To access resources in your subscription, you must assign an appropriate role to the custom Microsoft Entra ID application. Do the following:

Use the search bar to locate the Subscriptions service.
Open the Subscriptions page.
Select the subscription to which to assign the application.
Open Access control (IAM) and select Add > Add role assignment. The Add role assignment page opens.
Assign your custom Microsoft Entra ID application the Owner role.

Setting the connection properties

The connection properties you set to connect with your custom Microsoft Entra ID application will vary, depending on whether you want to authenticate using a Client Secret or a Certificate.

After you connect, authentication with client credentials takes place automatically like any other connection, except that no window opens to prompt the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Client Secret Connection Properties

AuthScheme: AzureServicePrincipal.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthClientId: The client ID in your custom Microsoft Entra ID application settings.
OAuthClientSecret: The client secret in your custom Microsoft Entra ID application settings.

Certificate Connection Properties

AuthScheme: AzureServicePrincipalCert.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthJWTCert: The JWT Certificate store.
OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.
OAuthJWTIssuer: The issuer of the Java Web Token.

Note

In most cases, OAuthJWTIssuer takes the value of the OAuthClientId property and does not need to be individually set.

Managed identities for Azure resources

If you are connecting from an Azure VM with permissions for Azure Data Lake Storage, set AuthScheme to AzureMSI.

Create a Custom OAuth App

There are two types of custom app registrations: Microsoft Entra ID and Microsoft Entra ID with a Microsoft Entra service principal. Both are OAuth-based.

When to Create a Custom Application

The connector embeds OAuth Application Credentials with branding that can be used when connecting via either a Desktop Application or from a Headless Machine.

You may choose to use your own Microsoft Entra ID Application Credentials when you want to:

control branding of the Authentication Dialog
control the redirect URI that the application redirects the user to after the user authenticates
customize the permissions that you are requesting from the user

Custom Microsoft Entra ID Applications

You can use a custom app registration to authenticate a service account or a user account. You can always create a custom app registration, but note that desktop and headless connections support embedded OAuth, which simplifies the process of authentication. See "Establishing a Connection" for information about using the embedded OAuth application.

Create a Custom Microsoft Entra ID App

Follow the steps below to obtain the Microsoft Entra ID values for your application, the OAuthClientId and OAuthClientSecret.

Log in to https://portal.azure.com.
In the left-hand navigation pane, select All services. Filter and select App registrations.
Click New registrations.
Enter an application name and select the desired tenant setup.

When creating a custom app registration in Microsoft Entra ID, you can define whether the application is single- or multi-tenant. If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Microsoft Entra ID Tenant when establishing a connection with the Jitterbit Connector for Microsoft Excel. Otherwise, the authentication attempt fails with an error. If your application is for private use only, "Accounts in this organization directory only" should be sufficient. Otherwise, if you want to distribute your application, choose one of the multi-tenant options.
Set the redirect URL to http://localhost:33333, the connector's default. Or, specify a different port and set CallbackURL to the exact reply URL you defined.
Click Register to register the new application. This opens an application management screen. Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
Navigate to the "Certificates & Secrets" and define the application authentication type. There are two types of authentication available: using a client secret or a certificate. The recommended authentication method is using a certificate.
- Option 1: Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
- Option 2: Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will need it as the OAuthClientSecret.
Select API Permissions > Add a permission > Azure Storage > user_impersonation > Add permissions.
Save your changes.
If you have selected to use permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page. Otherwise, follow the steps under "Admin Consent".

Custom Microsoft Entra ID Service Principal Applications

When authenticating using a Microsoft Entra service principal, you must create both a custom app registration and a service principal that can access the necessary resources. Follow the steps below to create a custom app registration and obtain the connection properties for Microsoft Entra service principal authentication.

Create a Custom Microsoft Entra ID App with a Microsoft Entra service principal

Follow the steps below to obtain the Microsoft Entra ID values for your application.

Log in to https://portal.azure.com.
In the left-hand navigation pane, select All services. Filter and select App registrations.
Click New registrations.
Enter an app name and select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant). Then set the redirect URL to http://localhost:33333, the connector's default.
After creating the application, copy the Application (client) ID value displayed in the "Overview" section. This value is used as the OAuthClientId
Define the app authentication type by going to the "Certificates & Secrets" section. There are two types of authentication available: using a client secret and using a certificate. The recommended authentication method is via a certificate.
- Option 1 - Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
- Option 2 - Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will use it as the OAuthClientSecret.
On the Authentication tab, make sure to select Access tokens (used for implicit flows).

Add Service Principal to Workspace

Follow the steps below to add a service principal to a workspace.

Log in to Microsoft Fabric.
Click the gear icon (Settings) on the top right.
Select Admin portal.
In the left-hand navigation pane, select Tenant settings.
Scroll until you find Developer settings.
Expand Service principals can use Fabric APIs.
Enable the option.
Select Apply.
Select the workspace where you want to add your service principal.
Click Manage access.
Click Add people or groups.
Enter the name of your application (verify the ID if there are multiple applications with the same name).
Set the level of access you would like to grant to your application. Contributor is the lowest security level necessary to access OneLake via the API.
Select Add.

Connect to SFTP

You can authenticate to SFTP using a user and password or an SSH certificate. Additionally, you can connect to an SFTP server that has no authentication enabled.

No Authentication

Set SSHAuthMode to None to connect without authentication, assuming your server supports doing so.

Password

Provide user credentials associated with your SFTP server:

SSHAuthMode: Set this to Password.
SSHUser: A username associated with your SFTP server.
SSHPassword: The password associated with the user.

SSH Certificate

Set the following to connect.

SSHAuthMode: Set this to Public_Key.
SSHClientCert: Specify the SSH certificate in the form specified by SSHClientCertType (see the associated documentation for this connection property).
SSHClientCertType: The type of the key store specified in SSHClientCert.
SSHClientCertPassword (optional): The certificate store password.
SSHClientCertSubject (optional): If there are multiple keys in your key store, specify the desired key, by name, here.

Connect to SharePoint Online

Connect to SharePoint Online (GRAPH)

The following authentication schemes are supported for the Graph API:

Microsoft Entra ID
MSI
AzureServicePrincipal

Microsoft Entra ID

Microsoft Entra ID (Microsoft Entra ID) is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Microsoft Excel using an internet browser. The driver facilitates this in several ways as described below. Set your AuthScheme to Microsoft Entra ID. The Microsoft Entra ID flows described below assume that you have done so.

Your organization may require Admin Consent when authorizing a new app registration for your Azure Tenant. In all Microsoft Entra ID flows, any initial installation and use of an app registration requires that an administrator approve the application for their Azure Tenant.

Desktop Applications

The connector provides an embedded OAuth application that simplifies OAuth desktop authentication. Alternatively, you can create a custom app registration. See Creating a Custom Microsoft Entra ID App for information about creating custom applications and reasons for doing so.

For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom app registrations.

After setting the following connection properties, you are ready to connect:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId: (custom applications only) Set this to the client ID in your application settings.
OAuthClientSecret: (custom applications only) Set this to the client secret in your application settings.
CallbackURL: Set this to the Redirect URL in your application settings.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation. These stored values persist across connections.

Microsoft Entra service principal

Authentication as a Microsoft Entra service principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself.

All tasks taken by the application are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For Microsoft Entra service principal authentication, set AuthScheme to AzureServicePrincipal.

Creating an Microsoft Entra ID App and a Microsoft Entra service principal

If you will authenticate using a Microsoft Entra service principal, you must first create and register a Microsoft Entra ID application with a Microsoft Entra ID tenant, as described in Creating an Entra ID (Microsoft Entra ID) Application.

In portal.azure.com, navigate to App Registration > API Permissions. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under Application Permissions.

Assigning a role to the application

To access resources in your subscription, you must assign an appropriate role to the custom Microsoft Entra ID application. Do the following:

Use the search bar to locate the Subscriptions service.
Open the Subscriptions page.
Select the subscription to which to assign the application.
Open Access control (IAM) and select Add > Add role assignment. The Add role assignment page opens.
Assign your custom Microsoft Entra ID application the Owner role.

Setting the connection properties

The connection properties you set to connect with your custom Microsoft Entra ID application will vary, depending on whether you want to authenticate using a Client Secret or a Certificate.

After you connect, authentication with client credentials takes place automatically like any other connection, except that no window opens to prompt the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Client Secret Connection Properties

AuthScheme: AzureServicePrincipal.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthClientId: The client ID in your custom Microsoft Entra ID application settings.
OAuthClientSecret: The client secret in your custom Microsoft Entra ID application settings.

Certificate Connection Properties

AuthScheme: AzureServicePrincipalCert.
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: The tenant to which you want to connect.
OAuthJWTCert: The JWT Certificate store.
OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.
OAuthJWTIssuer: The issuer of the Java Web Token.

Note

In most cases, OAuthJWTIssuer takes the value of the OAuthClientId property and does not need to be individually set.

MSI

If you are running Microsoft Excel on an Azure VM, you can leverage Managed Service Identity (MSI) credentials to connect:

AuthScheme: Set this to AzureMSI.

The MSI credentials are automatically obtained for authentication.

Microsoft Entra service principal

When authenticating using a Microsoft Entra service principal, you must register an application with a Microsoft Entra ID tenant.

Assign a role to the application

To access resources in your subscription, you must assign a role to the application.

Open the Subscriptions page by searching and selecting the Subscriptions service from the search bar.
Select the particular subscription to assign the application to.
Open the Access control (IAM) and select Add > Add role assignment to open the Add role assignment page.
Select Owner as the role to assign to your created Microsoft Entra ID app.

Authenticate with a Microsoft Entra service principal

You are ready to connect after setting one of the below connection properties groups, depending on the configured app authentication (client secret or certificate).

Before choosing client secret or certicate authentication, set the following:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: Set this to the tenant you wish to connect to.
OAuthClientId: Set this to the client ID in your app settings.

Option 1: Authenticating using a Client Secret

Set the following to authenticate with a client secret:

AuthScheme: Set this to the AzureServicePrincipal in your app settings.
OAuthClientId: Set this to the client ID in your app settings.
OAuthClientSecret: Set this to the client secret in your app settings.

Option 2: Authenticating using a JWT Certificate

Set the following to authenticate with a JWT Certificate:

AuthScheme: Set this to the AzureServicePrincipal in your app settings.
OAuthJWTCert: Set this to the JWT Certificate store.
OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.

Connect to SharePoint Online (REST V1)

SharePoint REST V1 uses the SharePoint REST API v1 (_api/web/) with the sprestv1:// URI scheme. It supports both on-premise and SharePoint Online environments. The following authentication schemes are supported for SharePoint Online:

Microsoft Entra ID
ADFS
Okta
OneLogin
PingFederate

Microsoft Entra ID

Microsoft Entra ID (Microsoft Entra ID / Entra ID) uses OAuth 2.0 to authenticate with Microsoft Entra ID and obtain an access token for the SharePoint REST API. Set the AuthScheme to Microsoft Entra ID. The following connection properties are used to connect:

InitiateOAuth: Set this to GETANDREFRESH to have the connector manage the OAuth token exchange and refresh automatically.
OAuthClientId: (custom applications only) Set this to the client ID in your Microsoft Entra ID application settings.
OAuthClientSecret: (custom applications only) Set this to the client secret in your Microsoft Entra ID application settings.
CallbackURL: Set this to the Redirect URL configured in your Microsoft Entra ID application.
AzureTenant: (optional) Set this to the Microsoft Entra ID tenant ID or domain. Defaults to common for multi-tenant applications. Required when connecting to SharePoint On Premise with Entra ID.

The following is an example connection string:

AuthScheme=Microsoft Entra ID;InitiateOAuth=GETANDREFRESH;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

ADFS

Set the AuthScheme to ADFS. You must set the following connection properties:

User: Set this to the ADFS user.
Password: Set this to the ADFS password for the user.
SSOLoginURL: Set this to the base URL for your ADFS server.

The following is an example connection string:

AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

Okta

Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:

User: Set this to the Okta user.
Password: Set this to the Okta password for the user.
SSOLoginURL: Set this to your Okta application's embed link.

The following is an example connection string:

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

OneLogin

Set the AuthScheme to OneLogin. The following connection properties are used to connect to OneLogin:

User: Set this to the OneLogin user.
Password: Set this to the OneLogin password for the user.

The following is an example connection string:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

PingFederate

Set the AuthScheme to PingFederate. The following connection properties are used to connect to PingFederate:

User: Set this to the PingFederate user.
Password: Set this to the PingFederate password for the user.
SSOLoginURL: Set this to the base URL for your PingFederate server.

The following is an example connection string:

AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

Create a Custom Microsoft Entra ID App

When to Create a Custom OAuth App

The connector embeds OAuth Application Credentials with branding that can be used when connecting via either a Desktop Application or from a Headless Machine. Creating a custom OAuth application is, however, required when using a web application.

You may choose to create your own OAuth Application Credentials when you want to:

control branding of the Authentication Dialog
control the redirect URI that the application redirects the user to after the user authenticates
customize the permissions that you are requesting from the user

Create a Custom OAuth App

Follow the steps below to obtain OAuth values for your app, the OAuthClientId and OAuthClientSecret.

Log in to the Azure Portal.
In the left-hand navigation pane, select Microsoft Entra ID > App Registrations and click Add.
Enter an application name and select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant). Then set the redirect URL to http://localhost:33333, the connector's default or set a different port of your choice and set CallbackURL to the exact reply URL you defined.
After creating the app, navigate to the "Certificates & Secrets" section, create a client secret for the application, and select a duration.
After you save the key, key value is displayed once. Set OAuthClientSecret to the displayed value. Set OAuthClientId to the Application Id.
Select API Permissions and click Add. If your application connects without a user context, select Application Permissions. If your application authenticates on behalf of a signed-in user, choose Delegated permissions.
In the API Permissions section, click on Add a permission and select Sharepoint. Choose the permissions you want your app to have. To view and edit lists, you have to select (at least) the AllSites.Manage permission.
Save your changes.
If you have selected to use permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page. Otherwise, follow the steps under "Admin Consent".

Connect to SharePoint On Premise

SharePoint On Premise can be accessed using either the SharePoint SOAP or SharePoint REST V1 connection type.

SharePoint SOAP uses the SharePoint SOAP API with the sp:// URI scheme.
SharePoint REST V1 uses the SharePoint REST API v1 (_api/web/) with the sprestv1:// URI scheme.

Note

SharePoint REST V1 supports connecting to both on-premise and SharePoint Online environments. The SSO authentication schemes (ADFS, Okta, OneLogin, PingFederate) authenticate through Microsoft's SharePoint Online cloud endpoints. For SharePoint Online-specific guidance, see also Connecting to SharePoint Online.

The following authentication schemes are supported for both connection types:

User Credentials
NTLM

Additionally, SharePoint REST V1 supports:

ADFS
Okta
OneLogin
Microsoft Entra ID (Microsoft Entra ID / Entra ID)

User Credentials

Set the AuthScheme to Basic. You must set the following connection properties:

User: Set this to the SharePoint user.
Password: Set this to the SharePoint password for the user.

Below is an example connection string:

AuthScheme=Basic;User=yourUserName;Password=yourPassword;ConnectionType='SharePoint SOAP';URI='sp://Shared Documents/';StorageBaseURL=http://sharePointServer/;

AuthScheme=Basic;User=yourUserName;Password=yourPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=http://sharePointServer/sites/mysite;

ADFS

Set the AuthScheme to ADFS. You must set the following connection properties:

User: Set this to the ADFS user.
Password: Set this to the ADFS password for the user.
SSOLoginURL: Set this to the base URL for your ADFS server.

Below is an example connection string:

AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

Okta

Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:

User: Set this to the Okta user.
Password: Set this to the Okta password for the user.
SSOProperties:
- Domain (optional): It may be required to set this property if the domain configured for SSO is different from the domain of the User.

The following is an example connection string:

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

OneLogin

Set the AuthScheme to OneLogin. The following connection properties are used to connect to OneLogin:

User: Set this to the OneLogin user.
Password: Set this to OneLogin password for the user.
SSOProperties:
- Domain (optional): It may be required to set this property if the domain configured for SSO is different from the domain of the User.

The following is an example connection string:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

NTLM

Set the AuthScheme to NTLM. The following connection properties are used to connect to NTLM:

User: Set this to the NTLM user.
Password: Set this to the NTLM password for the user.

The following are example connection strings:

AuthScheme=NTLM;User=NtlmUsername;Password=NtlmPassword;ConnectionType='SharePoint SOAP';URI='sp://Documents/';StorageBaseURL=http://sharePointServer/;

AuthScheme=NTLM;User=NtlmUsername;Password=NtlmPassword;ConnectionType='SharePoint SOAP';URI='sp://Documents/mycars.Excel';StorageBaseURL=http://sharePointServer/;

AuthScheme=NTLM;User=NtlmUsername;Password=NtlmPassword;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=http://sharePointServer/sites/mysite;

Microsoft Entra ID

Microsoft Entra ID (Microsoft Entra ID / Entra ID) authentication is supported for SharePoint REST V1 only. This uses OAuth 2.0 to authenticate with Microsoft Entra ID and obtain an access token for the SharePoint REST API. This works for both SharePoint Online and SharePoint Server on-premise (when configured with Entra ID as an OIDC identity provider, such as SharePoint Server Subscription Edition). Set the AuthScheme to Microsoft Entra ID. The following connection properties are used to connect:

OAuthClientId: Set this to the client ID in your Microsoft Entra ID application settings.
OAuthClientSecret: Set this to the client secret in your Microsoft Entra ID application settings.
CallbackURL: Set this to the Redirect URL configured in your Microsoft Entra ID application.
InitiateOAuth: Set this to GETANDREFRESH to have the connector manage the OAuth token exchange and refresh automatically.
AzureTenant: Set this to the Microsoft Entra ID tenant ID or domain (for example, contoso.onmicrosoft.com or a tenant GUID). This is required for SharePoint On Premise.

The following are example connection strings:

AuthScheme=Microsoft Entra ID;AzureTenant=contoso.onmicrosoft.com;InitiateOAuth=GETANDREFRESH;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://sharePointServer/sites/mysite;

AuthScheme=Microsoft Entra ID;InitiateOAuth=GETANDREFRESH;ConnectionType='SharePoint REST V1';URI='sprestv1://Documents/';StorageBaseURL=https://subdomain.sharepoint.com/sites/mysite;

SSO connections

Authenticate with SSO

Service Provider	Okta	OneLogin	ADFS	Microsoft Entra ID
Amazon S3	Y		Y	Y
Azure Blob Storage
Azure Data Lake Store Gen1
Azure Data Lake Store Gen2
Azure Data Lake Store Gen2 with SSL
Google Drive
OneDrive
Box
Dropbox
SharePoint Online SOAP
SharePoint Online REST
SharePoint REST V1	Y	Y	Y	Y
Wasabi
Google Cloud Storage
Oracle Cloud Storage
Azure File

Microsoft Entra ID

Microsoft Entra ID Configuration

The main theme behind this configuration is the OAuth 2.0 On-Behalf-Of flow. It requires two Microsoft Entra ID applications:

An application used for the single sign-on process to a specific service provider.
- Amazon S3: Please follow this link for detailed instructions on how to create this application. Make sure you test the connection and you are able to login to the AWS console from Microsoft Entra ID.
  
  Save the step "Assign the Microsoft Entra ID test user" until after provisioning so that you can select the AWS roles when assigning the user.
A "connector" application with user_impersonation permission on the SSO application you created in the previous step.

Go to Microsoft Entra ID > App registrations and register a new application. After you register this application, you need to allow it to make API calls to the SSO application. Go to the API permissions section of the app you registered and click the "Add a permission" box. Select the API of your SSO application by specifying the API name or Application ID and add the user_impersonation permission.

Driver Common Properties

The following SSOProperties are needed to authenticate to Microsoft Entra ID and must be specified for every service provider.

Resource: The application ID URI of the SSO application, listed in the Overview section of the app registration.
Tenant: The ID of the Microsoft Entra ID tenant where the applications are registered. You can find this value using the instructions found here.

We will retrieve the SSO SAML response from an OAuth 2.0 On-Behalf-Of flow so the following OAuth connection properties must be specified:

OAuthClientId: The application ID of the connector application, listed in the Overview section of the app registration.
OAuthClientSecret: The client secret value of the connector application. Microsoft Entra ID displays this when you create a new client secret (Certificates & secrets section).

Amazon S3

In addition to the common properties, the following properties must be specified when connecting to Amazon S3 service provider:

AuthScheme: Set the AuthScheme to Microsoft Entra ID.
AWSRoleARN: The ARN of the IAM role. Find this on the Summary page of the IAM role.
AWSPrincipalARN: The ARN of the identity provider. Find this on the identity provider's summary page.

The following is an example connection string:

AuthScheme=Microsoft Entra ID;InitiateOAuth=GETANDREFRESH;OAuthClientId=d593a1d-ad89-4457-872d-8d7443aaa655;OauthClientSecret=g9-oy5D_rl9YEKfN-45~3Wm8FgVa2F;SSOProperties='Tenant=94be7-edb4-4fda-ab12-95bfc22b232f;Resource=https://signin.aws.amazon.com/saml;';AWSRoleARN=arn:aws:iam:2153385180:role/AWS_Microsoft Entra ID;AWSPrincipalARN=arn:aws:iam:215515180:saml-provider/Microsoft Entra ID;

OneLogin

OneLogin Configuration

You must create an application used for the single sign-on process to a specific provider.

SharePoint REST V1: Please follow this link for detailed instructions on how to create this application. Make sure you test the connection and you are able to login to Office 365 from OneLogin. Make sure you have enabled WS-TRUST in your application. Otherwise, the driver will not be able to connect.

SharePoint REST V1

The following properties must be specified when connecting to SharePoint REST V1 service provider:

AuthScheme: Set the AuthScheme to OneLogin.
User: The username of the OneLogin account.
Password: The password of the OneLogin account.
SSOProperties:
- Domain (optional): It may be required to set this property if the domain configured for SSO is different from the domain of the User.

The following is an example connection string:

AuthScheme='OneLogin';User=test;Password=test;SSOProperties='Domain=test.cdata;';StorageBaseURL='https://sharepointserver/sites/mysite';

Okta

Okta Configuration

You must create an application used for the single sign-on process to a specific provider.

SharePoint REST V1: Please follow this link for detailed instructions on how to create this application and configure SSO. Make sure you test the connection and you are able to login to Office 365 from Okta. Make sure you have configured SSO using WS-Federation in your application. Otherwise, the driver will not be able to connect.
Amazon S3: Please follow this link for detailed instructions on how to create this application and configure SSO. Make sure you test the connection and you are able to login to AWS from Okta. Make sure you have configured SSO with SAML 2.0 in your application. Otherwise, the driver will not be able to connect. Ensure that the assigned AWS role in the Okta app has access to the S3 bucket you want to connect.

SharePoint REST V1

The following properties must be specified when connecting to SharePoint REST V1 service provider:

AuthScheme: Set the AuthScheme to Okta.
User: The username of the Okta account.
Password: The password of the Okta account.
SSOProperties:
- Domain (optional): It may be required to set this property if the domain configured for SSO is different from the domain of the User.

The following is an example connection string:

AuthScheme='Okta';User=test;Password=test;SSOProperties='Domain=test.cdata;';StorageBaseURL='https://sharepointserver/sites/mysite';

Amazon S3

The following properties must be specified when connecting to an Amazon S3 service provider:

AuthScheme: Set the AuthScheme to Okta.
User: The username of the Okta account.
Password: The password of the Okta account.
SSOLoginURL: Set this to the embedded URL of your AWS Okta SSO app.
AWSRoleARN (optional): The ARN of the IAM role. Find this on the Summary page of the IAM role.
AWSPrincipalARN (optional): The ARN of the identity provider. Find this on the identity provider's summary page.
SSOProperties:
- APIToken (optional): Set this to the API Token that the customer created from the Okta org. It should be used when authenticating a user via a trusted application or proxy that overrides Okta client request context.

The following is an example connection string:

AuthScheme=Okta;User=OktaUser;Password=OktaPassword;SSOLoginURL='https://{subdomain}.okta.com/home/amazon_aws/0oan2hZLgQiy5d6/272';

ADFS

ADFS Configuration

You must create an application used for the single sign-on process to a specific provider.

SharePoint REST V1: Please follow this link for detailed instructions on how to set up ADFS for Office 365 for Single Sign-On. Make sure you test the connection and you are able to login to Office 365 from ADFS.
Amazon S3: Please follow this link for detailed instructions on how to set up ADFS for AWS Single Sign-On. Make sure you test the connection and you are able to login to AWS from ADFS.

SharePoint REST V1

The following properties must be specified when connecting to a SharePoint REST V1 service provider:

AuthScheme: Set the AuthScheme to ADFS.
User: The username of the ADFS account.
Password: The password of the ADFS account.
SSOProperties:
- Domain (optional): It may be required to set this property if the domain configured for SSO is different from the domain of the User.

The following is an example connection string:

AuthScheme='ADFS';User=test;Password=test;SSOProperties='Domain=test.cdata;';StorageBaseURL='https://sharepointserver/sites/mysite';

Amazon S3

The following properties must be specified when connecting to a SharePoint SOAP service provider:

AuthScheme: Set the AuthScheme to ADFS.
SSOLoginURL: Set this to the URL of your ADFS instance.
User: The username of the ADFS account.
Password: The password of the ADFS account.
AWSRoleARN (optional): The ARN of the IAM role. Find this on the Summary page of the IAM role.
AWSPrincipalARN (optional): The ARN of the identity provider. Find this on the identity provider's summary page.

The following is an example connection string:

AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';

ADFS Integrated

The ADFS Integrated flow indicates you are connecting with the currently logged in Windows user credentials. To use the ADFS Integrated flow, simply do not specify the User and Password, but otherwise follow the same steps in the ADFS guide above.

Fine-Tuning Data Access

Advanced Data Modeling Settings

Use the following properties to control the tables the connector discovers, return values, and other aspects of data access.

Schema Discovery

Orientation: Model tables that match the orientation of your spreadsheet: Set this to Horizontal or Vertical.
DefineTables: Explicitly specify the ranges you want to access as tables, using the standard Excel range format: [Table Name]=[Sheet Name]![Range]. Specify multiple tables in a semicolon-separated list:
```
  DefineTables="Table1=Sheet1!A1:N25,Table2=Sheet2!C3:M53"
```
Note that the connector automatically detects the named ranges in a sheet and reports them as tables. You can also specify a range in the FROM clause:
```
 SELECT * FROM Excel_Sheet#A5:F* 
```

Column Discovery

Header: Detect column names from the first row if true. Otherwise, the pseudo column names A, B, C, etc. will be used.
TypeDetectionScheme: Determines how the connector detects the data types of columns.
RowScanDepth: When using the row-scan type detection scheme, set this property to the number of rows to scan to determine column data types.

Advanced Excel Integration

Formulas

AllowFormula: Whether to insert or update the formula result or the formula expression.
Recalculate: Recalculate formulas when the data is changed.
IgnoreCalcError: Ignore errors that occurred when formulas are calculated.
HasCrossSheetReferences: Recalculate formulas across all worksheets when the data is changed; the connector will follow cross sheet references, but there is a performance cost.

Miscellaneous

EmptyValueMode: Configure how to handle cells that are empty. An empty cell is a cell that contains an empty string (e.g., =""). You can return an empty cell as an empty string or a null string (default: return an empty string.)
NullValueMode: Configure how to handle cells that have not been set. An unset cell is different from an empty cell. Unset cells contain a null string. You can return an unset cell as an empty string or a null string (default: return NULL).
BufferChanges: Indicates whether to hold changes to the data in memory until the connection is closed.

Use Kerberos

Kerberos

To authenticate to Microsoft Excel with Kerberos, set AuthScheme to NEGOTIATE.

Authenticating to Microsoft Excel via Kerberos requires you to define authentication properties and to choose how Kerberos should retrieve authentication tickets.

Retrieve Kerberos Tickets

Kerberos tickets are used to authenticate the requester's identity. The use of tickets instead of formal logins/passwords eliminates the need to store passwords locally or send them over a network. Users are reauthenticated (tickets are refreshed) whenever they log in at their local computer or enter kinit USER at the command prompt.

The connector provides three ways to retrieve the required Kerberos ticket, depending on whether or not the KRB5CCNAME and/or KerberosKeytabFile variables exist in your environment.

MIT Kerberos Credential Cache File

This option enables you to use the MIT Kerberos Ticket Manager or kinit command to get tickets. With this option there is no need to set the User or Password connection properties.

This option requires that KRB5CCNAME has been created in your system.

To enable ticket retrieval via MIT Kerberos Credential Cache Files:

Ensure that the KRB5CCNAME variable is present in your environment.
Set KRB5CCNAME to a path that points to your credential cache file. (For example, C:\krb_cache\krb5cc_0 or /tmp/krb5cc_0.) The credential cache file is created when you use the MIT Kerberos Ticket Manager to generate your ticket.
To obtain a ticket:
1. Open the MIT Kerberos Ticket Manager application.
2. Click Get Ticket.
3. Enter your principal name and password.
4. Click OK.
If the ticket is successfully obtained, the ticket information appears in Kerberos Ticket Manager and is stored in the credential cache file.

The connector uses the cache file to obtain the Kerberos ticket to connect to Microsoft Excel.

Note

If you would prefer not to edit KRB5CCNAME, you can use the KerberosTicketCache property to set the file path manually. After this is set, the connector uses the specified cache file to obtain the Kerberos ticket to connect to Microsoft Excel.

Keytab File

If your environment lacks the KRB5CCNAME environment variable, you can retrieve a Kerberos ticket using a Keytab File.

To use this method, set the User property to the desired username, and set the KerberosKeytabFile property to a file path pointing to the keytab file associated with the user.

User and Password

If your environment lacks the KRB5CCNAME environment variable and the KerberosKeytabFile property has not been set, you can retrieve a ticket using a user and password combination.

To use this method, set the User and Password properties to the user/password combination that you use to authenticate with Microsoft Excel.

Enable Cross-Realm Authentication

More complex Kerberos environments can require cross-realm authentication where multiple realms and KDC servers are used. For example, they might use one realm/KDC for user authentication, and another realm/KDC for obtaining the service ticket.

To enable this kind of cross-realm authentication, set the KerberosRealm and KerberosKDC properties to the values required for user authentication. Also, set the KerberosServiceRealm and KerberosServiceKDC properties to the values required to obtain the service ticket.

Important Notes

Configuration Files and Their Paths

All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Excel Operations

The Jitterbit Connector for Microsoft Excel allows you to manipulate Excel files in a variety of ways. The connector supports reading data vertically and horizontally as well as from user-defined ranges and named ranges. Refer to Selecting Data and Modifying Data for examples of different ways of querying and modifying spreadsheet data.

Select Data

Excel worksheets can be organized in different ways. The connector offers settings to select data based on various organizational methods.

With Header Cells

If a spreadsheet has column headers the connector can use them to represent the column names of the worksheet table. To use header cells set the Header property to True. Then you can query like so:

SELECT RowId, Name, Item, Quantity, Amount FROM Sheet1 WHERE Amount > '50'

The query above assumes that the first row of the spreadsheet has the column names RowId, Name, Quantity, and Amount. The spreadsheet may have more columns than were selected and they can be in any order.

Without Header Cells

If a spreadsheet does not have header columns, or if you would like to ignore the header columns, you can set the Header property to false. In this case each column is represented by the column name in Excel; i.e., A, B, C, ...

SELECT A, B, C, D FROM Sheet1 WHERE D > '50'

Orientation

If a spreadsheet is laid out horizontally (i.e., the column names are arranged vertically in the first column) then you can set the Orientation property to Horizontal to read each column as a row in the table. The Orientation property can be used in conjunction with the Header connection property, and the range syntax described below.

If header columns are not set and the orientation is horizontal, the column names will be R1, R2, R3, ...

SELECT R1, R2, R3 FROM Sheet1 WHERE R2 > '50'

Range

You can use the range feature to select data from a specific portion of the spreadsheet; for example, if you have a sparse spreadsheet that is not top-left aligned or if the data of interest is somewhere in the middle of the sheet. The range is specified as part of the table name. For example the following command will select the range of cells between A1 and E5:

SELECT * FROM Excel_Sheet#A1:E5

In case the sheet name contains a quote, if you want to select only a range, the correct Excel syntax involves using an extra quote as an escape character and enclosing the full sheet name with quotes. For example the following command will select the range of cells between A1 and E5 for the sheet named Excel'Sheet:

SELECT * FROM ['Excel''Sheet'#A1:E5]

You can also use wildcards (*) in the ending cell for the range. Ranges similar to '#A5:F*', '#A5:*20', and '#A5:**' are supported. For example the following command will select the range of cells between A5 and column F, up to the last row in the spreadsheet:

SELECT * FROM Excel_Sheet#A5:F*

Named Range

If a spreadsheet has named range defined in it, then you can query this range as if it were a table. You can issue the following query to select data from the named range SALES.

SELECT * FROM SALES

Modify Data

The Jitterbit Connector for Microsoft Excel supports INSERT, UPDATE, and DELETE; more details are below.

Update and Delete

Updates and deletes require you to uniquely identify a single row by specifying the RowId column.

See Using Formulas to insert formulas.

Insert

You can insert new rows anywhere in the sheet, including inserting to named ranges.

Add a Row

You can add new rows to your spreadsheet using the INSERT statement. If the Header property is set to True, then you can insert based on the column headers. If the Header property is false, then you must use the cell names (A, B, C, etc.) to insert a row. When you insert a row, it is appended to the end of the sheet. This new row will be assigned a RowId based on where it is on the Excel sheet.

It is also possible to insert a row at the end of a range of cells. To do so, simply use the range in the table name while inserting a row.

INSERT INTO Sheet1#C1:D5 (A, B) VALUES ('Brian', '30')

The code above will add Brian and 30 to the end of the range; i.e., the cells C6 and D6.

Insert a Row

Sometimes you might want to insert a row in the middle of an Excel sheet. The connector supports this using the INSERT command with the RowId, which identifies the row number. If the RowId is specified with the INSERT query, the connector will add the row at the specified row number. All rows at and below the specified row number will be moved down one row, and their RowId will be incremented by one. For example:

INSERT INTO Sheet1 (RowId, A, B) VALUES (5, 'Brian', '30')

The code above will insert the values Brian and 30 to the cells A5 and B5. The existing data in row 5 and below will be moved down one row.

Add a Row to a Named Range

It is also possible to insert a row at the end of the named range. To do so, simply insert a row without the RowId to the table named after the range. The code below will append a new row to the end of the named range SALES. The definition of the named range will be expanded to include the row that was just inserted.

INSERT INTO SALES (Year, Category, Total) VALUES (1997, 'Beverage', 30000)

Use Formulas

Excel formulas are recalculated when the spreadsheet is opened. The connector includes a formula engine that can natively calculate most of the commonly used Excel formulas. The connector stores the state of a previous calculation in the spreadsheet and uses it to make efficient choices of when recalculation is necessary.

Recalculate Formulas

The Recalculate property allows you to control if formulas should be calculated. You should set Recalculate to True when you intend to read data from a spreadsheet that has formulas and you know that formula results might not be up to date. Once a value has been calculated for a cell, it is also updated into the spreadsheet. This can help avoid recalculations.

Calculating formula cells can add to the processing time. If a spreadsheet has not been modified since the last recalculation, you may choose to omit the calculation and simply read the previously calculated value in the formula cell. To skip recalculation, set Recalculate to False. You may also want to omit formula calculation when you are opening a spreadsheet just to insert or update cells and not reading anything from it.

Insert Formulas

The connector allows you to insert formulas into cells. If the AllowFormula connection string property is set to true, then anything you insert beginning with an equals sign ('=') will be treated as a formula. For example, the following will insert a formula into the B column that will sum cells B1:B5:

INSERT INTO Excel_Sheet (A, B) VALUES ('Bill', '=SUM(B1:B5)')

Advanced Features

This section details a selection of advanced features of the Microsoft Excel connector.

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Microsoft Excel and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Log

For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Exception Handling

For an overview of how exceptions are reported and the components of an exception, see Exception Handling.

User Defined Views

The Jitterbit Connector for Microsoft Excel supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

Create a JSON-formatted configuration file defining the views you want.
DDL statements.

Define Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Sheet WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Client SSL Certificates

The Microsoft Excel connector also supports setting client certificates. Set the following to connect using a client certificate.

SSLClientCert: The name of the certificate store for the client certificate.
SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword: The password for the TLS/SSL client certificate.
SSLClientCertSubject: The subject of the TLS/SSL client certificate.

Query Processing

The connector includes a client-side SQL engine that offloads as much SELECT statement processing as possible to Microsoft Excel, then processes the remainder of the query in memory.

Two components manage this process:

The query evaluation component determines which parts of a query the data source can execute natively.
The query slicer breaks a complex query into multiple independent requests when necessary.

Wherever feasible, the connector pushes down as much of the query as possible to the data source to generate the most efficient query and reduce the size of the result set. Processing that cannot be pushed down is completed locally; some queries remain more expensive to compute client-side regardless of this optimization.

Logging

Set the Logfile and Verbosity connection properties to enable basic logging. Once set, the connector populates the log file as it carries out various tasks, such as when authentication is performed or queries are executed.

Verbosity levels 1 through 5 are supported, with each level building on the detail logged by the previous one: level 1 logs the query, the number of rows it returns, the start and duration of execution, and any errors; level 5 additionally logs communication with the data source and other details that may be helpful in troubleshooting. For normal operations, do not set Verbosity higher than 1: higher verbosity levels can log substantial amounts of data, which can delay execution times, and can capture sensitive information such as full request and response bodies. Review the log file for sensitive information before sharing it outside of your organization.

For more refined logging, use the following properties:

LogModules: Restricts logging to a semicolon-separated list of modules, so the log file only captures the categories of information you specify.
MaxLogFileSize: Sets the maximum size of a log file before the connector starts a new one.
MaxLogFileCount: Caps the number of log files the connector retains, deleting the oldest file once the limit is reached.

See Logging under "Advanced Configurations Properties" for the complete list of logging properties.

Exception Handling

Exceptions can be surfaced from either the API or the Jitterbit Connector for Microsoft Excel. Each exception will have an error code, an error message, and a SQL state.

Error Codes

The error code classifies the type of error.

| Property | ------------ | 0 | 65537 | 65538 | 65539 | 65540 | 65541 | 131073 | 131074 | 196609 | 196610 | 196611 | 196612 | 196613 | 196614 | 262145 | 262146 | 262147 | 262148 | 262149 | 262150 | 327681 | 327682 | 327683 | 327684 | 327685 | 393217 | 393218 | 393219 | 393220 | 458753 | 524289 | 524290 | 524291 | 524292 | 524293 | 524294 | Description | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | NONE | Used for unclassified errors and internally handled errors. This code also covers data source-specific errors that do not fit in any specific category. | | TCP_UNKNOWN_HOST | Unable to resolve a hostname (DNS failure). | | TCP_CONNECTION_REFUSED | Could not connect to the remote port. | | TCP_AUTH_FAILED | Login failed when using a binary authentication protocol. Use this for auth errors when the protocol is not HTTP (LDAP, SASL, Kerberos, ...). | | TCP_TIMEOUT | Did not receive a response after sending a request to the server. | | TCP_PROTOCOL | For wire protocol drivers. Either the server sent a bad packet that we are unable to process, or we cannot construct a packet to send. | | TLS_SERVER_UNTRUSTED | Could not verify SSL server certificate. | | TLS_CLIENT_UNTRUSTED | Server did not accept the client certificate we sent. | | OAUTH_DECRYPT_FAILED | OAuthEncryptKey did not decrypt the OAuthSettings file. | | OAUTH_MISSING_CLIENT_INFO | OAuthClientId / OAuthClientSecret / OAuthJWTCert is missing. | | OAUTH_MISSING_PROP | General OAuth property missing. OAUTH_MISSING_CLIENT_INFO is used for missing client ID/secret and JWT cert. | | OAUTH_NO_ACCESS_TOKEN | Unable to retrieve access token. Only use this when getting a token in GetOAuthAccessToken / RefreshOAuthAccessToken. | | OAUTH_TOKEN_EXPIRED | The access token expired. Normally used with a RefreshOAuth/OAuthException behavior. | | OAUTH_INVALID_PROP | OAuth property has an invalid value. OAUTH_MISSING_CLIENT_INFO / OAUTH_MISSING_PROP is used if the value is not set. | | HTTP_REQUEST_TIMEOUT | Did not receive a response from the HTTP server. | | HTTP_CLIENT_ERROR | Generic HTTP 4xx error. Only use for 4xx errors not covered by other codes. | | HTTP_AUTH_FAILED | HTTP 401 error. | | HTTP_LIMIT_EXCEEDED | HTTP 429 error. | | HTTP_SERVER_ERROR | HTTP 5xx error. | | HTTP_NOT_FOUND_ERROR | HTTP 404 error. | | CORE_TIMEOUT | General timeout. Not related to a specific network request. | | CORE_OP_NOT_ALLOWED | Operation blocked by provider permissions. | | CORE_CONNECTION_CONFIG | Connection configuration is not valid. | | CORE_SERIALIZE | Failed to encode data into a specific format (XML, JSON, CSV, ...). | | CORE_DESERIALIZE | Failed to decode data from a specific format (XML, JSON, CSV, ...). | | SQL_SYNTAX_ERROR | Unable to parse a SQL query. | | SQL_MISSING_COLUMNS | Query did not include required columns. | | SQL_MISSING_PARAMS | Stored procedure call did not include required parameters. | | SQL_QUERY_NOT_SUPPORTED | A part of the query is not allowed in the current context. | | SSH_SERVER_UNTRUSTED | Could not verify SSH server. | | STORAGE_LIST_EXCEPTION | Issue listing storage resources. | | STORAGE_RESOURCE_NOT_FOUND | Issue finding storage resources. | | STORAGE_ROOT_RESOURCE_NOT_FOUND | The root resource (bucket/share/drive) was not found; cannot create it in flat file drivers. | | STORAGE_RESOURCE_NOT_A_DIRECTORY | Storage resource is not a directory. | | STORAGE_RESOURCE_NOT_A_FILE | Storage resource is not a file. | | STORAGE_PERMISSIONS_DENIED | Storage permissions denied. |

SQL State

The SQL state is used when throwing generic provider errors to the wrapper and indicates the success or failure of a call. Some of the common SQL states are listed below:

| Property | Description | | ------------ | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 07007 | REQUIRED_CLAUSE | Class Code 07: Dynamic SQL Error. | | 08001 | OPEN_CONNECTION | Class Code 08: Connection Exception. The connection was unable to be established to the application server or other server. | | 08004 | REJECT_CONNECTION | The application server rejected establishment of the connection. | | 42501 | PRIVILEGE_IDENTIFIED_OBJECT | Class Code 42: Syntax Error or Access Rule Violation. The authorization ID does not have the privilege to perform the specified operation on the identified object. | | 42506 | AUTH_FAILED | Owner authorization failure occurred. | | 42601 | SQL_SYNTAX | A character, token, or clause is invalid or missing. |

Error Message

The error message provides more detailed reasoning about why the error occurred. It provides an explanation of the issue, and may include steps on how to resolve it.

DATE Functions

The connector supports the following date and time functions, which can be used in SQL queries and in connection properties that accept filter expressions, such as ExcludeFiles and IncludeFiles:

Function	Description
`CURRENT_DATE()`	Returns the current date value.
`CURRENT_TIMESTAMP()`	Returns the current time stamp of the database system as a datetime value. This value is equal to `GETDATE` and `SYSDATETIME`, and is always in the local time zone.
`DATEADD(datepart, integer_number, date [, dateformat])`	Returns the datetime value that results from adding the specified signed integer to the specified date part of the date.
`DATEDIFF(datepart, startdate, enddate)`	Returns the signed integer difference of the specified time interval between the specified start date and end date.
`DATEFROMPARTS(integer_year, integer_month, integer_day)`	Returns the datetime value for the specified year, month, and day.
`DATENAME(datepart, date)`	Returns the character string that represents the specified date part of the specified date.
`DATEPART(datepart, date [, integer_datefirst])`	Returns the character string that represents the specified date part of the specified date.
`DATETIME2FROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)`	Returns the datetime value for the specified date parts.
`DATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_milliseconds)`	Returns the datetime value for the specified date parts.
`DATE_TRUNC(date, datepart)`	Truncates the date to the precision of the given date part, modeled after the Oracle `TRUNC` function.
`DATE_TRUNC2(datepart, date [, weekday])`	Truncates the date to the precision of the given date part, modeled after the PostgreSQL `date_trunc` function.
`DAY(date)`	Returns the integer that specifies the day component of the specified date.
`DAYOFMONTH(date)`	Returns the day of the month of the given date part.
`DAYOFWEEK(date)`	Returns the day of the week of the given date part.
`DAYOFYEAR(date)`	Returns the day of the year of the given date part.
`EOMONTH(date [, integer_month_to_add])`	Returns the last day of the month that contains the specified date, with an optional offset.
`LAST_DAY(date)`	Returns the last day of the month that contains the specified date.
`FDWEEK(date)`	Returns the first day of the week of the given date part.
`FDMONTH(date)`	Returns the first day of the month of the given date part.
`FDQUARTER(date)`	Returns the first day of the quarter of the given date part.
`FILEMODIFIEDTIME(uri)`	Returns the time stamp associated with the date modified of the relevant file.
`FROM_DAYS(datevalue)`	Returns a date derived from the number of days after 1582-10-15 (based on the Gregorian calendar). This is equivalent to the MySQL `FROM_DAYS` function.
`GETDATE()`	Returns the current time stamp of the database system as a datetime value. This value is equal to `CURRENT_TIMESTAMP` and `SYSDATETIME`, and is always in the local time zone.
`GETUTCDATE()`	Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to `SYSUTCDATETIME`.
`HOUR(date)`	Returns the hour component from the provided datetime.
`ISDATE(date [, date_format])`	Returns `1` if the value is a valid date, time, or datetime value; otherwise, `0`.
`LAST_WEEK()`	Returns a time stamp equivalent to exactly one week before the current date.
`LAST_MONTH()`	Returns a time stamp equivalent to exactly one month before the current date.
`LAST_YEAR()`	Returns a time stamp equivalent to exactly one year before the current date.
`LDWEEK(date)`	Returns the last day of the provided week.
`LDMONTH(date)`	Returns the last day of the provided month.
`LDQUARTER(date)`	Returns the last day of the provided quarter.
`MAKEDATE(year, days)`	Returns a date value from a year and a number of days.
`MINUTE(date)`	Returns the minute component from the provided datetime.
`MONTH(date)`	Returns the month component from the provided datetime.
`QUARTER(date)`	Returns the quarter associated with the provided datetime.
`SECOND(date)`	Returns the second component from the provided datetime.
`SMALLDATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute)`	Returns the datetime value for the specified date and time.
`STRTODATE(string, format)`	Parses the provided string value and returns the corresponding datetime.
`SYSDATETIME()`	Returns the current time stamp as a datetime value of the database system. It is equal to `GETDATE` and `CURRENT_TIMESTAMP`, and is always in the local time zone.
`SYSUTCDATETIME()`	Returns the current system date and time as a UTC datetime value. It is equal to `GETUTCDATE`.
`TIMEFROMPARTS(integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)`	Returns the time value for the specified time, with the specified precision.
`TO_DAYS(date)`	Returns the number of days since 0000-00-01. This only returns a value for dates on or after 1582-10-15 (based on the Gregorian calendar). This is equivalent to the MySQL `TO_DAYS` function.
`WEEK(date)`	Returns the week of the year associated with the provided datetime.
`YEAR(date)`	Returns the integer that specifies the year of the specified date.

Data Model

The Jitterbit Connector for Microsoft Excel models Excel workbooks as relational databases. Spreadsheets and ranges comprise the tables.

Executing SQL to Spreadsheets

Excel Operations shows various ways to work with spreadsheet data.

Advanced Data Modeling

You can fine-tune the data model to match your workbook's organization. The connector supports reading data that is oriented vertically or horizontally, as well as sparse spreadsheets organized in user-defined ranges and named ranges.

See Fine-Tuning Data Access to configure the connection string to control the tables the connector discovers, return values, and other aspects of data access.

Stored Procedures

In addition to working with the data in the spreadsheet, you can use the available stored procedures to change the metadata of an Excel file.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Excel.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Excel, along with an indication of whether the procedure succeeded or failed.

Jitterbit Connector for Microsoft Excel Stored Procedures

Name	Description
`CreateSchema`	Generates a schema file that defines the structure of data within an Excel resource, including table layouts, column types, and metadata. This is typically used to initialize or validate workbook content against a defined schema.
`CreateWorksheet`	Creates a new worksheet within a specified Excel workbook. If the target workbook does not already exist, this procedure will create the workbook first and then add the new worksheet.
`DeleteFile`	Delete a file from a local or cloud storage.
`DownloadFile`	Download a file.
`FreezePanes`	Locks specific rows and/or columns in an Excel worksheet so they remain visible while a user scrolls through the rest of the data. This feature enhances readability and is used for header rows or important reference columns in large datasets.
`GetOAuthAccessToken`	Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Excel.
`GetOAuthAuthorizationURL`	Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.
`RefreshOAuthAccessToken`	Refreshes an expired OAuth Access Token to maintain continuous authenticated access to Excel resources without requiring reauthorization from the user.
`UploadFile`	Upload file to destination.

CreateSchema

Generates a schema file that defines the structure of data within an Excel resource, including table layouts, column types, and metadata. This is typically used to initialize or validate workbook content against a defined schema.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The connector checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the connector.

Input

Name	Type	Description
`TableName`	`String`	Specifies the logical name of the Excel dataset to be exposed as a table, which also determines the name of the resulting schema file (.rsd). This name acts as both an identifier for the resource and the basis for schema generation.
`URI`	`String`	Provides the Uniform Resource Identifier (URI) pointing to the Excel data source. This input is deprecated, as the URI is now derived automatically from the TableName parameter. It remains for backward compatibility.
`FileName`	`String`	Defines the target name for the schema file to be generated, including the .rsd extension. The exact location is controlled by the Location connection property, which should point to the desired output directory.

Result Set Columns

Name	Type	Description
`Result`	`String`	Indicates the result of the schema creation process. It returns either Success if the operation completed without errors, or Failure if an issue was encountered during execution.
`FileData`	`String`	Contains the raw schema file data in binary form when the FileName input is not specified. This allows clients to handle the file contents directly in memory without writing to disk.

CreateWorksheet

Creates a new worksheet within a specified Excel workbook. If the target workbook does not already exist, this procedure will create the workbook first and then add the new worksheet.

Input

Name	Type	Description
`File`	`String`	The full file path to the target Excel workbook where the new worksheet will be created. If the file does not exist, it will be generated during the operation.
`Sheet`	`String`	The desired name for the new worksheet to be added within the Excel workbook. The name must be unique within the workbook to avoid naming conflicts. The default value is sheet1.
`Columnnames`	`String`	Comma-separated list of column headers to include in the new worksheet. Each name in the list must not contain any white space characters. Format: Column1, Column2, Column3.

Result Set Columns

Name	Type	Description
`File`	`String`	Returns the name of the Excel workbook that was modified or created during the procedure execution. This helps confirm the destination file that was affected.
`Sheet`	`String`	Returns the final name of the worksheet that was created within the workbook. This can differ from the original input if a naming conflict required the system to rename the worksheet.

DeleteFile

Delete a file from a local or cloud storage.

Input

Name	Type	Description
`Path`	`String`	The full path of the file to delete. Relative to the path provided in the URI connection property.

Result Set Columns

Name	Type	Description
`Success`	`Bool`	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
`Details`	`String`	Details of execution failure. NULL if success=true.

DownloadFile

Download a file.

Input

Name	Type	Description
`Path`	`String`	The full path of the file to download. Relative to the path provided in the URI connection property.
`LocalPath`	`String`	The absolute path where the file will be saved.

Result Set Columns

Name	Type	Description
`Success`	`Bool`	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
`Details`	`String`	Details of execution failure. NULL if success=true.
`FileData`	`String`	The file data encoded as BASE64. Returns a value only if LocalPath and OutputStream inputs are empty.

FreezePanes

Locks specific rows and/or columns in an Excel worksheet so they remain visible while a user scrolls through the rest of the data. This feature enhances readability and is used for header rows or important reference columns in large datasets.

Input

Name	Type	Description
`File`	`String`	The full path to the Excel workbook file where the freeze operation will be performed. This should include the file name and extension, such as C:\Reports\SalesData.xlsx.
`Sheet`	`String`	The name of the worksheet within the specified Excel file where the freeze panes operation will take place. The name must match an existing worksheet in the workbook. The default value is sheet1.
`Freezeposition`	`String`	Specifies the top-left cell that defines the freeze panes region. All rows above and columns to the left of this cell will remain visible when scrolling. To remove any existing freeze, set this value to 'UnFreeze'.

Result Set Columns

Name	Type	Description
`Result`	`String`	Returns the status of the operation, indicating whether the freeze panes action was successfully applied or if it failed during execution.

GetOAuthAccessToken

Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Excel.

Input

Name	Type	Description
`Other_Options`	`String`	Other options to control behavior of OAuth.
`Cert`	`String`	Path for a personal certificate .pfx file. Only available for OAuth 1.0.
`Cert_Password`	`String`	Personal certificate password. Only available for OAuth 1.0.
`AuthToken`	`String`	The request token returned by GetOAuthAuthorizationUrl. Available only for OAuth 1.0.
`AuthKey`	`String`	The request secret key returned by GetOAuthAuthorizationUrl. Available only for OAuth 1.0.
`AuthSecret`	`String`	This field is deprecated. Please use AuthKey going forward.
`Sign_Method`	`String`	The signature method used to calculate the signature for OAuth 1.0. The allowed values are HMAC-SHA1, PLAINTEXT. The default value is HMAC-SHA1.
`GrantType`	`String`	Authorization grant type. Only available for OAuth 2.0. The allowed values are CODE, PASSWORD, CLIENT, REFRESH.
`Post_Data`	`String`	The post data to submit, if any.
`AuthMode`	`String`	The type of authentication mode to use. The allowed values are APP, WEB. The default value is WEB.
`Verifier`	`String`	The verifier code returned by the data source after permission for the app to connect has been granted. WEB AuthMode only.
`Scope`	`String`	The scope of access to the APIs. By default, access to all APIs used by this data provider will be specified.
`CallbackURL`	`String`	This field determines where the response is sent.
`Prompt`	`String`	This field indicates the prompt to present the user. It accepts one of the following values: NONE, CONSENT, SELECT ACCOUNT. The default is SELECT_ACCOUNT, so a given user will be prompted to select the account to connect to. If it is set to CONSENT, the user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user. The default value is SELECT_ACCOUNT.
`AccessType`	`String`	This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to ONLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.
`State`	`String`	This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Google authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.

Result Set Columns

Name	Type	Description
`OAuthAccessToken`	`String`	The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
`OAuthAccessTokenSecret`	`String`	The OAuth access token secret.
`OAuthRefreshToken`	`String`	A token that may be used to obtain a new access token.
`ExpiresIn`	`String`	The remaining lifetime on the access token.
`\*`	`String`	Other outputs that may be returned by the data source.

GetOAuthAuthorizationURL

Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.

Input

Name	Type	Description
`Cert`	`String`	Path for a personal certificate .pfx file. Only available for OAuth 1.0.
`Cert_Password`	`String`	Personal certificate password. Only available for OAuth 1.0.
`Sign_Method`	`String`	The signature method used to calculate the signature for OAuth 1.0. The allowed values are HMAC-SHA1, PLAINTEXT. The default value is HMAC-SHA1.
`Scope`	`String`	The scope of access to the APIs. By default, access to all APIs used by this data provider will be specified.
`CallbackURL`	`String`	The URL the user will be redirected to after authorizing your application.
`Prompt`	`String`	This field indicates the prompt to present the user. It accepts one of the following values: NONE, CONSENT, SELECT ACCOUNT. The default is SELECT_ACCOUNT, so a given user will be prompted to select the account to connect to. If it is set to CONSENT, the user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user. The default value is SELECT_ACCOUNT.
`AccessType`	`String`	This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to ONLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.
`State`	`String`	This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Google authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
`Other_Options`	`String`	Other options to control the behavior of OAuth.

Result Set Columns

Name	Type	Description
`AuthToken`	`String`	The authorization token, passed into the GetOAuthAccessToken stored procedure.
`AuthKey`	`String`	The authorization key, passed into the GetOAuthAccessToken stored procedure.
`AuthSecret`	`String`	This field is deprecated. Use AuthKey going forward.
`URL`	`String`	The URL to complete user authentication.

RefreshOAuthAccessToken

Refreshes an expired OAuth Access Token to maintain continuous authenticated access to Excel resources without requiring reauthorization from the user.

Input

Name	Type	Description
`OAuthRefreshToken`	`String`	The refresh token returned from the original authorization code exchange.

Result Set Columns

Name	Type	Description
`OAuthAccessToken`	`String`	The authentication token returned from the data source. This can be used in subsequent calls to other operations for this particular service.
`OAuthRefreshToken`	`String`	The authentication token returned from the data source. This can be used in subsequent calls to other operations for this particular service.
`ExpiresIn`	`String`	The remaining lifetime on the access token.

UploadFile

Upload file to destination.

Input

Name	Type	Description
`DestinationPath`	`String`	The full path where the file should be uploaded to. Relative to the path provided in the URI connection property.
`LocalPath`	`String`	The path of the local file to upload.
`InputData`	`String`	Base64 string representation of the file content. Only used if LocalPath and InputStream are not set.

Result Set Columns

Name	Type	Description
`Success`	`Bool`	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
`Details`	`String`	Details of execution failure. NULL if success=true.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Microsoft Excel:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
`CatalogName`	`String`	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

Name	Type	Description
`CatalogName`	`String`	The database name.
`SchemaName`	`String`	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

Name	Type	Description
`CatalogName`	`String`	The database containing the table or view.
`SchemaName`	`String`	The schema containing the table or view.
`TableName`	`String`	The name of the table or view.
`TableType`	`String`	The table type (table or view).
`Description`	`String`	A description of the table or view.
`IsUpdateable`	`Boolean`	Whether the table can be updated.
`IsInsertable`	`Boolean`	Whether the table can be inserted into.
`IsDeleteable`	`Boolean`	Whether rows can be deleted from the table.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Sheet table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName = 'Sheet'

Columns

Name	Type	Description
`CatalogName`	`String`	The name of the database containing the table or view.
`SchemaName`	`String`	The schema containing the table or view.
`TableName`	`String`	The name of the table or view containing the column.
`ColumnName`	`String`	The column name.
`DataTypeName`	`String`	The data type name.
`DataType`	`Int32`	An integer indicating the data type. This value is determined at run time based on the environment.
`Length`	`Int32`	The storage size of the column.
`DisplaySize`	`Int32`	The designated column's normal maximum width in characters.
`NumericPrecision`	`Int32`	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
`NumericScale`	`Int32`	The column scale or number of digits to the right of the decimal point.
`IsNullable`	`Boolean`	Whether the column can contain null.
`Description`	`String`	A brief description of the column.
`Ordinal`	`Int32`	The sequence number of the column.
`IsAutoIncrement`	`String`	Whether the column value is assigned in fixed increments.
`IsGeneratedColumn`	`String`	Whether the column is generated.
`IsHidden`	`Boolean`	Whether the column is hidden.
`IsArray`	`Boolean`	Whether the column is an array.
`IsReadOnly`	`Boolean`	Whether the column is read-only.
`IsKey`	`Boolean`	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
`ColumnType`	`String`	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.
`ColumnCapabilities`	`Int32`	A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

Name	Type	Description
`CatalogName`	`String`	The database containing the stored procedure.
`SchemaName`	`String`	The schema containing the stored procedure.
`ProcedureName`	`String`	The name of the stored procedure.
`Description`	`String`	A description of the stored procedure.
`ProcedureType`	`String`	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CreateWorksheet stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'CreateWorksheet' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'CreateWorksheet' AND IncludeResultColumns='True'

Columns

Name	Type	Description
`CatalogName`	`String`	The name of the database containing the stored procedure.
`SchemaName`	`String`	The name of the schema containing the stored procedure.
`ProcedureName`	`String`	The name of the stored procedure containing the parameter.
`ColumnName`	`String`	The name of the stored procedure parameter.
`Direction`	`Int32`	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
`DataType`	`Int32`	An integer indicating the data type. This value is determined at run time based on the environment.
`DataTypeName`	`String`	The name of the data type.
`NumericPrecision`	`Int32`	The maximum precision for numeric data. The column length in characters for character and date-time data.
`Length`	`Int32`	The number of characters allowed for character data. The number of digits allowed for numeric data.
`NumericScale`	`Int32`	The number of digits to the right of the decimal point in numeric data.
`IsNullable`	`Boolean`	Whether the parameter can contain null.
`IsRequired`	`Boolean`	Whether the parameter is required for execution of the procedure.
`IsArray`	`Boolean`	Whether the parameter is an array.
`Description`	`String`	The description of the parameter.
`Ordinal`	`Int32`	The index of the parameter.
`Values`	`String`	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
`SupportsStreams`	`Boolean`	Whether the parameter represents a file that you can pass as either a file path or a stream.
`IsPath`	`Boolean`	Whether the parameter is a target path for a schema creation operation.
`Default`	`String`	The value used for this parameter when no value is specified.
`SpecificName`	`String`	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
`IsProvided`	`Boolean`	Whether the procedure is added/implemented by , as opposed to being a native Microsoft Excel procedure.

Pseudocolumns

Name	Type	Description
`IncludeResultColumns`	`Boolean`	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Sheet table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Sheet'

Columns

Name	Type	Description
`CatalogName`	`String`	The name of the database containing the key.
`SchemaName`	`String`	The name of the schema containing the key.
`TableName`	`String`	The name of the table containing the key.
`ColumnName`	`String`	The name of the key column.
`IsKey`	`Boolean`	Whether the column is a primary key in the table referenced in the TableName field.
`IsForeignKey`	`Boolean`	Whether the column is a foreign key referenced in the TableName field.
`PrimaryKeyName`	`String`	The name of the primary key.
`ForeignKeyName`	`String`	The name of the foreign key.
`ReferencedCatalogName`	`String`	The database containing the primary key.
`ReferencedSchemaName`	`String`	The schema containing the primary key.
`ReferencedTableName`	`String`	The table containing the primary key.
`ReferencedColumnName`	`String`	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

Name	Type	Description
`CatalogName`	`String`	The name of the database containing the key.
`SchemaName`	`String`	The name of the schema containing the key.
`TableName`	`String`	The name of the table containing the key.
`ColumnName`	`String`	The name of the key column.
`PrimaryKeyName`	`String`	The name of the primary key.
`ForeignKeyName`	`String`	The name of the foreign key.
`ReferencedCatalogName`	`String`	The database containing the primary key.
`ReferencedSchemaName`	`String`	The schema containing the primary key.
`ReferencedTableName`	`String`	The table containing the primary key.
`ReferencedColumnName`	`String`	The column name of the primary key.
`ForeignKeyType`	`String`	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns

Name	Type	Description
`CatalogName`	`String`	The name of the database containing the key.
`SchemaName`	`String`	The name of the schema containing the key.
`TableName`	`String`	The name of the table containing the key.
`ColumnName`	`String`	The name of the key column.
`KeySeq`	`String`	The sequence number of the primary key.
`KeyName`	`String`	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

Name	Type	Description
`CatalogName`	`String`	The name of the database containing the index.
`SchemaName`	`String`	The name of the schema containing the index.
`TableName`	`String`	The name of the table containing the index.
`IndexName`	`String`	The index name.
`ColumnName`	`String`	The name of the column associated with the index.
`IsUnique`	`Boolean`	True if the index is unique. False otherwise.
`IsPrimary`	`Boolean`	True if the index is a primary key. False otherwise.
`Type`	`Int16`	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
`SortOrder`	`String`	The sort order: A for ascending or D for descending.
`OrdinalPosition`	`Int16`	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
`Name`	`String`	The name of the connection property.
`ShortDescription`	`String`	A brief description.
`Type`	`String`	The data type of the connection property.
`Default`	`String`	The default value if one is not explicitly set.
`Values`	`String`	A comma-separated list of possible values. A validation error is thrown if another value is specified.
`Value`	`String`	The value you set or a preconfigured default.
`Required`	`Boolean`	Whether the property is required to connect.
`Category`	`String`	The category of the connection property.
`IsSessionProperty`	`String`	Whether the property is a session property, used to save information about the current connection.
`Sensitivity`	`String`	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
`PropertyName`	`String`	A camel-cased truncated form of the connection property name.
`Ordinal`	`Int32`	The index of the parameter.
`CatOrdinal`	`Int32`	The index of the parameter category.
`Hierarchy`	`String`	Shows dependent properties associated that need to be set alongside this one.
`Visible`	`Boolean`	Informs whether the property is visible in the connection UI.
`ETC`	`String`	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
`AGGREGATE_FUNCTIONS`	Supported aggregation functions.	`AVG`, `COUNT`, `MAX`, `MIN`, `SUM`, `DISTINCT`
`COUNT`	Whether COUNT function is supported.	`YES`, `NO`
`IDENTIFIER_QUOTE_OPEN_CHAR`	The opening character used to escape an identifier.	`[`
`IDENTIFIER_QUOTE_CLOSE_CHAR`	The closing character used to escape an identifier.	`]`
`SUPPORTED_OPERATORS`	A list of supported SQL operators.	`=`, `>`, `<`, `>=`, `<=`, `<>`, `!=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, `OR`
`GROUP_BY`	Whether GROUP BY is supported, and, if so, the degree of support.	`NO`, `NO_RELATION`, `EQUALS_SELECT`, `SQL_GB_COLLATE`
`STRING_FUNCTIONS`	Supported string functions.	`LENGTH`, `CHAR`, `LOCATE`, `REPLACE`, `SUBSTRING`, `RTRIM`, `LTRIM`, `RIGHT`, `LEFT`, `UCASE`, `SPACE`, `SOUNDEX`, `LCASE`, `CONCAT`, `ASCII`, `REPEAT`, `OCTET`, `BIT`, `POSITION`, `INSERT`, `TRIM`, `UPPER`, `REGEXP`, `LOWER`, `DIFFERENCE`, `CHARACTER`, `SUBSTR`, `STR`, `REVERSE`, `PLAN`, `UUIDTOSTR`, `TRANSLATE`, `TRAILING`, `TO`, `STUFF`, `STRTOUUID`, `STRING`, `SPLIT`, `SORTKEY`, `SIMILAR`, `REPLICATE`, `PATINDEX`, `LPAD`, `LEN`, `LEADING`, `KEY`, `INSTR`, `INSERTSTR`, `HTML`, `GRAPHICAL`, `CONVERT`, `COLLATION`, `CHARINDEX`, `BYTE`
`NUMERIC_FUNCTIONS`	Supported numeric functions.	`ABS`, `ACOS`, `ASIN`, `ATAN`, `ATAN2`, `CEILING`, `COS`, `COT`, `EXP`, `FLOOR`, `LOG`, `MOD`, `SIGN`, `SIN`, `SQRT`, `TAN`, `PI`, `RAND`, `DEGREES`, `LOG10`, `POWER`, `RADIANS`, `ROUND`, `TRUNCATE`
`TIMEDATE_FUNCTIONS`	Supported date/time functions.	`NOW`, `CURDATE`, `DAYOFMONTH`, `DAYOFWEEK`, `DAYOFYEAR`, `MONTH`, `QUARTER`, `WEEK`, `YEAR`, `CURTIME`, `HOUR`, `MINUTE`, `SECOND`, `TIMESTAMPADD`, `TIMESTAMPDIFF`, `DAYNAME`, `MONTHNAME`, `CURRENT_DATE`, `CURRENT_TIME`, `CURRENT_TIMESTAMP`, `EXTRACT`
`REPLICATION_SKIP_TABLES`	Indicates tables skipped during replication.
`REPLICATION_TIMECHECK_COLUMNS`	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
`IDENTIFIER_PATTERN`	String value indicating what string is valid for an identifier.
`SUPPORT_TRANSACTION`	Indicates if the provider supports transactions such as commit and rollback.	`YES`, `NO`
`DIALECT`	Indicates the SQL dialect to use.
`KEY_PROPERTIES`	Indicates the properties which identify the uniform database.
`SUPPORTS_MULTIPLE_SCHEMAS`	Indicates if multiple schemas may exist for the provider.	`YES`, `NO`
`SUPPORTS_MULTIPLE_CATALOGS`	Indicates if multiple catalogs may exist for the provider.	`YES`, `NO`
`DATASYNCVERSION`	The Data Sync version needed to access this driver.	`Standard`, `Starter`, `Professional`, `Enterprise`
`DATASYNCCATEGORY`	The Data Sync category of this driver.	`Source`, `Destination`, `Cloud Destination`
`SUPPORTSENHANCEDSQL`	Whether enhanced SQL functionality beyond what is offered by the API is supported.	`TRUE`, `FALSE`
`SUPPORTS_BATCH_OPERATIONS`	Whether batch operations are supported.	`YES`, `NO`
`SQL_CAP`	All supported SQL capabilities for this driver.	`SELECT`, `INSERT`, `DELETE`, `UPDATE`, `TRANSACTIONS`, `ORDERBY`, `OAUTH`, `ASSIGNEDID`, `LIMIT`, `LIKE`, `BULKINSERT`, `COUNT`, `BULKDELETE`, `BULKUPDATE`, `GROUPBY`, `HAVING`, `AGGS`, `OFFSET`, `REPLICATE`, `COUNTDISTINCT`, `JOINS`, `DROP`, `CREATE`, `DISTINCT`, `INNERJOINS`, `SUBQUERIES`, `ALTER`, `MULTIPLESCHEMAS`, `GROUPBYNORELATION`, `OUTERJOINS`, `UNIONALL`, `UNION`, `UPSERT`, `GETDELETED`, `CROSSJOINS`, `GROUPBYCOLLATE`, `MULTIPLECATS`, `FULLOUTERJOIN`, `MERGE`, `JSONEXTRACT`, `BULKUPSERT`, `SUM`, `SUBQUERIESFULL`, `MIN`, `MAX`, `JOINSFULL`, `XMLEXTRACT`, `AVG`, `MULTISTATEMENTS`, `FOREIGNKEYS`, `CASE`, `LEFTJOINS`, `COMMAJOINS`, `WITH`, `LITERALS`, `RENAME`, `NESTEDTABLES`, `EXECUTE`, `BATCH`, `BASIC`, `INDEX`
`PREFERRED_CACHE_OPTIONS`	A string value specifies the preferred cacheOptions.
`ENABLE_EF_ADVANCED_QUERY`	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	`YES`, `NO`
`PSEUDO_COLUMNS`	A string array indicating the available pseudo columns.
`MERGE_ALWAYS`	If the value is true, The Merge Mode is forcibly executed in Data Sync.	`TRUE`, `FALSE`
`REPLICATION_MIN_DATE_QUERY`	A select query to return the replicate start datetime.
`REPLICATION_MIN_FUNCTION`	Allows a provider to specify the formula name to use for executing a server side min.
`REPLICATION_START_DATE`	Allows a provider to specify a replicate startdate.
`REPLICATION_MAX_DATE_QUERY`	A select query to return the replicate end datetime.
`REPLICATION_MAX_FUNCTION`	Allows a provider to specify the formula name to use for executing a server side max.
`IGNORE_INTERVALS_ON_INITIAL_REPLICATE`	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
`CHECKCACHE_USE_PARENTID`	Indicates whether the CheckCache statement should be done against the parent key column.	`TRUE`, `FALSE`
`CREATE_SCHEMA_PROCEDURES`	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
`NAME`	`String`	A component of SQL syntax, or a capability that can be processed on the server.
`VALUE`	`String`	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

Name	Type	Description
`Id`	`String`	The database-generated ID returned from a data modification operation.
`Batch`	`String`	An identifier for the batch. 1 for a single operation.
`Operation`	`String`	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
`Message`	`String`	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
`Product`	`String`	The name of the product.
`Version`	`String`	The version number of the product.
`Datasource`	`String`	The name of the datasource the product connects to.
`NodeId`	`String`	The unique identifier of the machine where the product is installed.
`HelpURL`	`String`	The URL to the product's help documentation.
`License`	`String`	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
`Location`	`String`	The file path location where the product's library is stored.
`Environment`	`String`	The version of the environment or rumtine the product is currently running under.
`DataSyncVersion`	`String`	The tier of Sync required to use this connector.
`DataSyncCategory`	`String`	The category of Sync functionality (e.g., Source, Destination).

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

Property	Description
`AuthScheme`	The type of authentication to use when connecting to remote services.
`AccessKey`	The access key used to authenticate to Microsoft Excel. This value is accessible from your security credentials page.
`SecretKey`	Your account secret key. This value is accessible from your security credentials page.
`User`	The user account used to authenticate.
`Password`	The password used to authenticate the user.
`SharePointEdition`	The edition of SharePoint being used. Set either SharePointOnline or SharePointOnPremise.

Connection

Property	Description
`ConnectionType`	Specifies the file storage service, server, or file access protocol through which your Microsoft Excel files are stored and retreived.
`URI`	A Uniform Resource Identifier (URI) to a resource location containing Excel workbook file(s).
`DefineTables`	A list of cell ranges within spreadsheets to model as tables.
`Header`	Specifies whether the first row (or column, when Orientation=Horizontal) is used as a source of column names.
`Orientation`	Indicates whether the data in Excel is laid out horizontally or vertically.
`BufferChanges`	Specifies whether to wait until the connection is closed to apply changes made to workbook data.
`Region`	The hosting region for your S3-like Web Services.
`OracleNamespace`	The Oracle Cloud Object Storage namespace to use.
`StorageBaseURL`	Specifies the URL of a cloud storage service provider.
`UseVirtualHosting`	If true (default), buckets will be referenced in the request using the hosted-style request: `http://yourbucket.s3.amazonaws.com/yourobject`. If set to false, the bean will use the path-style request: `http://s3.amazonaws.com/yourbucket/yourobject`. Note that this property will be set to false, in case of an S3 based custom service when the CustomURL is specified.
`TestConnectionBehavior`	Specifies the behavior of the test connection operation.
`UseLakeFormation`	When this property is set to true, AWSLakeFormation service will be used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through OKTA, ADFS, Microsoft Entra ID, PingFederate, while providing a SAML assertion.

AWS Authentication

Property	Description
`AWSAccessKey`	Specifies your AWS account access key. This value is accessible from your AWS security credentials page.
`AWSSecretKey`	Your AWS account secret key. This value is accessible from your AWS security credentials page.
`AWSRoleARN`	The Amazon Resource Name of the role to use when authenticating. Multiple roles can be specified separated by semicolons for role chaining.
`AWSPrincipalARN`	The ARN of the SAML Identity provider in your AWS account.
`AWSRegion`	The hosting region for your Amazon Web Services.
`AWSSessionToken`	Your AWS session token.
`AWSExternalId`	A unique identifier that might be required when you assume a role in another account.
`MFASerialNumber`	The serial number of the MFA device if one is being used.
`MFAToken`	The temporary token available from your MFA device.
`CredentialsLocation`	The location of the settings file where MFA credentials are saved.
`AWSCredentialsFile`	The location of your credentials file.
`AWSCredentialsFileProfile`	The name of the profile you would like to use from the specified credentials file.
`TemporaryTokenDuration`	The amount of time (in seconds) a temporary token will last.
`AWSWebIdentityToken`	The OAuth 2.0 access token or OpenID Connect ID token that is provided by an identity provider.
`AWSContainerCredentialsFullURI`	The full URI of the container credential provider endpoint used by EKS Pod Identity.
`AWSContainerAuthorizationTokenFile`	The path to a file containing the authorization token for the EKS Pod Identity credential provider.

Azure Authentication

Property	Description
`AzureStorageAccount`	The name of your Azure storage account.
`AzureAccessKey`	The storage key associated with your Azure account.
`AzureSharedAccessSignature`	A shared access key signature that may be used for authentication.
`AzureTenant`	Identifies the Microsoft Excel tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
`AzureEnvironment`	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

SSO

Property	Description
`SSOLoginURL`	The identity provider's login URL.
`SSOProperties`	Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
`SSOExchangeURL`	The URL used for consuming the SAML response and exchanging it for service specific credentials.

Data

Property	Description
`AllowFormula`	Specifies whether to treat values starting with an equals (=) sign as formulas during inserts and updates.
`EmptyValueMode`	Specifies whether to read cells containing empty strings as empty or as null.
`NullValues`	Identifies a comma-separated list of values to read as null.
`IgnoreCalcError`	Specifies whether to include spreadsheet calculation error types in query results.
`NullValueMode`	Specifies whether unset cells are read as NULL or as empty strings.
`HasCrossSheetReferences`	Specifies how cross-sheet references are handled.
`Recalculate`	Specifies whether to recalculate formula values when cells involved in formula calculation are updated.
`ShowEmptyRows`	Determines whether empty rows are included in query results.
`TypeDetectionScheme`	Determines how the provider detects the data types of columns.
`EnableOleDbCompatibility`	Specifies whether to emulate how the Microsoft OLE DB Driver reports newline characters.
`UseFastInsert`	Indicates whether to use the efficient insert mode, which forces inserts to append new lines to the bottom of the spreadsheet.
`AggregateFiles`	Enables the ability to aggregate the content of identically-named sheets across multiple workbook files.
`SkipTop`	Specifies the number of rows (or columns, when Orientation=Horizontal) immediately after the header to omit from query results.
`IncludeCustomNames`	Indicates whether or not the defined names should be pushed.
`IncludeSubdirectories`	Indicates whether to include workbook files in subdirectories when list.
`MetadataDiscoveryURI`	Identifies the workbook that is used as the source of metadata when aggregating sheets with the AggregateFiles connection property.
`PathSeparator`	The character used to represent path separators when calculating the names of tables based on spreadsheets in nested folders.

OAuth

Property	Description
`InitiateOAuth`	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
`OAuthVersion`	Identifies the version of OAuth being used.
`OAuthClientId`	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
`OAuthClientSecret`	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
`OAuthAccessToken`	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
`OAuthAccessTokenSecret`	The OAuth access token secret for connecting using OAuth.
`OAuthSettingsLocation`	Specifies the location of the settings file where OAuth values are saved.
`CallbackURL`	Identifies the URL users return to after authenticating to Microsoft Excel via OAuth (Custom OAuth applications only).
`Scope`	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
`OAuthPasswordGrantMode`	Specifies how the OAuth Client ID and Client Secret are sent to the authorization server.
`OAuthIncludeCallbackURL`	Whether to include the callback URL in an access token request.
`OAuthAuthorizationURL`	The authorization URL for the OAuth service.
`OAuthAccessTokenURL`	The URL from which the OAuth access token is retrieved.
`OAuthRefreshTokenURL`	The URL to refresh the OAuth token from.
`OAuthRequestTokenURL`	The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0.
`OAuthVerifier`	Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
`AuthToken`	The authentication token used to request and obtain the OAuth Access Token.
`AuthKey`	The authentication secret used to request and obtain the OAuth Access Token.
`OAuthParams`	A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
`OAuthRefreshToken`	Specifies the OAuth refresh token used to request a new access token after the original has expired.
`OAuthExpiresIn`	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
`OAuthTokenTimestamp`	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

JWT OAuth

Property	Description
`OAuthJWTCert`	Supplies the name of the client certificate's JWT Certificate store.
`OAuthJWTCertType`	Identifies the type of key store containing the JWT Certificate.
`OAuthJWTCertPassword`	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
`OAuthJWTCertSubject`	Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
`OAuthJWTIssuer`	The issuer of the Java Web Token.
`OAuthJWTSubject`	The user subject for which the application is requesting delegated access.

Kerberos

Property	Description
`KerberosKDC`	Identifies the Kerberos Key Distribution Center (KDC) service used to authenticate the user. (SPNEGO or Windows authentication only).
`KerberosRealm`	Identifies the Kerberos Realm used to authenticate the user.
`KerberosSPN`	Identifies the service principal name (SPN) for the Kerberos Domain Controller.
`KerberosUser`	Confirms the principal name for the Kerberos Domain Controller, which uses the format host/user@realm.
`KerberosKeytabFile`	Identifies the Keytab file containing your pairs of Kerberos principals and encrypted keys.
`KerberosServiceRealm`	Identifies the service's Kerberos realm. (Cross-realm authentication only).
`KerberosServiceKDC`	Identifies the service's Kerberos Key Distribution Center (KDC).
`KerberosTicketCache`	Specifies the full file path to an MIT Kerberos credential cache file.

SSL

Property	Description
`SSLClientCert`	Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
`SSLClientCertType`	Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
`SSLClientCertPassword`	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
`SSLClientCertSubject`	Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
`SSLMode`	The authentication mechanism to be used when connecting to the FTP or FTPS server.
`SSLServerCert`	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSH

Property	Description
`SSHAuthMode`	The authentication method used when establishing an SSH Tunnel to the service.
`SSHClientCert`	A certificate to be used for authenticating the SSHUser.
`SSHClientCertPassword`	The password of the SSHClientCert key if it has one.
`SSHClientCertSubject`	The subject of the SSH client certificate.
`SSHClientCertType`	The type of SSHClientCert private key.
`SSHUser`	The SSH user.
`SSHPassword`	The SSH password.

Logging

Property	Description
`Logfile`	A filepath which designates the name and location of the log file.
`Verbosity`	The verbosity level that determines the amount of detail included in the log file.
`LogModules`	Core modules to be included in the log file.
`MaxLogFileSize`	A string specifying the maximum size in bytes for a log file (for example, 10 MB).
`MaxLogFileCount`	A string specifying the maximum file count of log files.

Schema

Property	Description
`Location`	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
`BrowsableSchemas`	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC .
`Tables`	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC .
`Views`	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC .

Miscellaneous

Property	Description
`AWSCertificate`	The absolute path to the certificate file or the certificate content in PEM format encoded in base64.
`AWSCertificatePassword`	The password for the certificate if applicable, otherwise leave blank.
`AWSCertificateType`	The type of AWSCertificate .
`AWSPrivateKey`	The absolute path to the private key file or the private key content in PEM format encoded in base64.
`AWSPrivateKeyPassword`	The password for the private key if it is encrypted, otherwise leave blank.
`AWSPrivateKeyType`	The type of AWSPrivateKey .
`AWSProfileARN`	Profile to pull policies from.
`AWSSessionDuration`	Duration, in seconds, for the resulting session.
`AWSTrustAnchorARN`	Trust anchor to use for authentication.
`Charset`	Specifies the session character set for encoding and decoding character data transferred to and from the Microsoft Excel file. The default value is UTF-8.
`ClientCulture`	This property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'.
`Culture`	This setting can be used to specify culture settings that determine how the provider interprets certain data types that are passed into the provider. For example, setting Culture='de-DE' will output German formats even on an American machine.
`CustomHeaders`	Specifies additional HTTP headers to append to the request headers created from other properties, such as ContentType and From. Use this property to customize requests for specialized or nonstandard APIs.
`CustomURLParams`	A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.
`DirectoryRetrievalDepth`	Specifies how many levels of subfolders are scanned when IncludeSubdirectories is enabled.
`ExcludeFiles`	A comma-separated list of filters to exclude from the set of files.
`FolderId`	The ID of a folder in Google Drive. If set, the resource location specified by the URI is relative to the Folder ID for all operations.
`GenerateSchemaFiles`	Indicates the user preference as to when schemas should be generated and saved.
`IncludeDropboxTeamResources`	Indicates if you want to include Dropbox team files and folders.
`IncludeFiles`	A comma-separated list of filters to include from the set of files.
`IncludeItemsFromAllDrives`	Whether Google Drive shared drive items should be included in results. If not present or set to false, then shared drive items are not returned.
`MaxRows`	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
`Other`	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
`PseudoColumns`	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
`RowScanDepth`	The maximum number of rows to scan to look for the columns available in a table.
`StringDecode`	Specifies whether hexadecimal characters are decoded in query results.
`Timeout`	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
`UserDefinedViews`	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
`UseSimpleNames`	Specifies whether or not simple names should be used for schemas, tables and columns.

Authentication

This section provides a complete list of authentication properties you can configure.

Property	Description
`AuthScheme`	The type of authentication to use when connecting to remote services.
`AccessKey`	The access key used to authenticate to Microsoft Excel. This value is accessible from your security credentials page.
`SecretKey`	Your account secret key. This value is accessible from your security credentials page.
`User`	The user account used to authenticate.
`Password`	The password used to authenticate the user.
`SharePointEdition`	The edition of SharePoint being used. Set either SharePointOnline or SharePointOnPremise.

AuthScheme

The type of authentication to use when connecting to remote services.

Possible Values

AwsRootKeys, AwsEC2Roles, AwsIAMRoles, ADFS, Okta, PingFederate, AwsTempCredentials, AwsCredentialsFile, Microsoft Entra ID, Keycloak, EKSPodIdentity, AzureMSI, AzureServicePrincipal, AzureServicePrincipalCert, AccessKey, AzureStorageSAS, IAMSecretKey, OAuth, Basic, NTLM, OneLogin, SFTP, None, Negotiate, OAuthClient, OAuthJWT, OAuthPKCE, GCPInstanceAccount, Digest, OAuthPassword, NONE

Data Type

string

Default Value

NONE

Remarks

Amazon S3

The following options are available when ConnectionType is set to Amazon S3:

AwsRootKeys: Set this to use the root user access key and secret. Useful for quickly testing, but production use cases are encouraged to use something with narrowed permissions.
AwsEC2Roles: Set this to automatically use IAM Roles assigned to the EC2 machine the Jitterbit Connector for Microsoft Excel is currently running on.
AwsIAMRoles: Set to use IAM Roles for the connection.
ADFS: Set to use a single sign on connection with ADFS as the identify provider.
OKTA: Set to use a single sign on connection with OKTA as the identify provider.
PingFederate: Set to use a single sign on connection with PingFederate as the identify provider.
AwsTempCredentials: Set this to leverage temporary security credentials alongside a session token to connect.
AwsCredentialsFile: Set to use a credential file for authentication.
Microsoft Entra ID: Set to use a single sign on connection with Microsoft Entra ID as the identify provider.
Keycloak: Set to use a single sign on connection with Keycloak as the identify provider.
EKSPodIdentity: Set to use EKS Pod Identity for authentication. Automatically retrieves temporary credentials from the EKS Pod Identity Agent running on the node.

Azure Services

The following options are available when ConnectionType is set to Azure Blob Storage, Azure Data Lake Storage Gen1, Azure Data Lake Storage Gen2, Azure Data Lake Storage Gen2 SSL, or OneDrive:

Microsoft Entra ID: Set this to perform Microsoft Entra ID OAuth authentication.
AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
AzureServicePrincipal: Set this to authenticate as a Microsoft Entra service principal.
AzureServicePrincipalCert: Set this to authenticate as a Microsoft Entra service principal using a Certificate.
AccessKey: Set this to authenticate with the storage key associated with your Microsoft Excel account.
AzureStorageSAS: Set this to authenticate with Shared Access Signature (SAS).

OneLake

The following options are available when ConnectionType is set to OneLake:

Microsoft Entra ID: Set this to perform Microsoft Entra ID OAuth authentication.
AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
AzureServicePrincipal: Set this to authenticate as a Microsoft Entra service principal.
AzureServicePrincipalCert: Set this to authenticate as a Microsoft Entra service principal using a Certificate.

Azure Files

Only the following option is available when ConnectionType is set to Azure Files:

AccessKey: Set this to authenticate with the storage key associated with your Microsoft Excel account.
AzureStorageSAS: Set this to authenticate with Shared Access Signature (SAS).

Box

The following options are available when ConnectionType is set to Box:

OAuth: Uses OAuth2 using a standard user account. OAuthVersion must be set to 2.0.
OAuthClient: Uses OAuth2 with the client credentials grant type. OAuthClientId and OAuthClientSecret are the credentials. OAuthVersion must be set to 2.0.
OAuthJWT: Uses OAuth2 with the JWT bearer grant type. OAuthJWTCertType and OAuthJWTCert determine what certificate the JWT is signed with. OAuthVersion must be set to 2.0.

Dropbox

Only the following option is available when ConnectionType is set to Dropbox:

OAuth: Uses OAuth2 with the authorization code grant type. OAuthVersion must be set to 2.0.

FTP(S)

Only the following option is available when ConnectionType is set to FTP or FTPS:

Basic: Basic user credentials (user/password).

Various Google Services

The following options are available when ConnectionType points Google Cloud Storage or Google Drive:

OAuth: Uses OAuth2 using a standard user account. OAuthVersion must be set to 2.0.
OAuthPKCE: Uses OAuth2 with the authorization code grant type and PKCE extension. OAuthVersion must be set to 2.0.
OAuthJWT: Uses OAuth2 with the JWT bearer grant type. OAuthJWTCertType and OAuthJWTCert determine what certificate the JWT is signed with. OAuthVersion must be set to 2.0.
GCPInstanceAccount: When running on a GCP virtual machine, the provider can authenticate using a service account tied to the virtual machine.

HDFS

The following options are available when ConnectionType is set to HDFS or HDFS Secure:

None: No authentication is used.
Negotiate: Kerberos authentication.

HTTP

The following options are available when ConnectionType is set to HTTP or HTTPS:

None: No authentication is used.
Basic: Basic user/password authentication.
Digest: Uses HTTP Digest authentication with User and Password.
OAuth: Uses either OAuth1 or OAuth2. OAuthVersion must be set to determine what version of OAuth is used.
- Bearer Token authentication: AuthScheme=OAuth, InitiateOAuth=Off, and OAuthAccessToken=Bearer token value.
OAuthJWT: Uses OAuth2 with the JWT bearer grant type. OAuthJWTCertType and OAuthJWTCert determine what certificate the JWT is signed with. OAuthVersion must be set to 2.0.
OAuthPassword: Uses OAuth2 with the password grant type. User and Password are the credentials. OAuthVersion must be set to 2.0.
OAuthClient: Uses OAuth2 with the client credentials grant type. OAuthClientId and OAuthClientSecret are the credentials. OAuthVersion must be set to 2.0.
OAuthPKCE: Uses OAuth2 with the authorization code grant type and PKCE extension. OAuthClientId is the credential. OAuthVersion must be set to 2.0.

IBM Cloud Object Storage

The following options are also available when ConnectionType is set to IBM Object Storage Source:

OAuth: Uses OAuth with the specific flow being determined by the InitiateOAuth. ApiKey must be set to successfully complete this flow.
IAMSecretKey: Uses AccessKey and SecretKey to authenticate to IBM Cloud Object Storage.

Oracle Cloud Storage

Only the following option is available when ConnectionType is set to Oracle Cloud Storage:

IAMSecretKey: Uses AccessKey and SecretKey to authenticate to the Oracle Cloud Storage.

SFTP

When ConnectionType is set to SFTP, the connector sets AuthScheme to SFTP. When AuthScheme is set to SFTP, the precise authentication method is controlled using the SSHAuthMode property. See this property's documentation for further information.

SharePoint GRAPH

The following options are also available when ConnectionType is set to SharePoint GRAPH:

Microsoft Entra ID: Set this to perform Microsoft Entra ID OAuth authentication.
AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
AzureServicePrincipal: Set this to authenticate as a Microsoft Entra service principal.
AzureServicePrincipalCert: Set this to authenticate as a Microsoft Entra service principal using a Certificate.

SharePoint SOAP

The following options are available when ConnectionType is set to SharePoint SOAP:

Basic: Use basic user/password credentials to authenticate.
NTLM: Set this to use your Windows credentials for authentication.

SharePoint REST V1

The following options are also available when ConnectionType is set to SharePoint REST V1. SharePoint REST V1 supports both on-premise and SharePoint Online environments:

Basic: Use basic user/password credentials to authenticate. On-premise only.
NTLM: Set this to use your Windows credentials for authentication. On-premise only.
ADFS: Set to use a single sign-on (SSO) connection with ADFS as the identity provider. SharePoint Online only.
Okta: Set to use an SSO connection with Okta as the identity provider. SharePoint Online only.
OneLogin: Set to use an SSO connection with OneLogin as the identity provider. SharePoint Online only.
PingFederate: Set to use an SSO connection with PingFederate as the identity provider. SharePoint Online only.
Microsoft Entra ID: Set this to perform Microsoft Entra ID (Entra ID) OAuth authentication. On-premise and SharePoint Online.

The User and Password connection properties, if they are applicable to the current ConnectionType and AuthScheme, are used together to authenticate to the service or platform containing your Microsoft Excel files.

This property will refer to different things based on the context, namely the value of ConnectionType and AuthScheme:

ConnectionType=AmazonS3
- AuthScheme=ADFS: This refers to your ADFS username.
- AuthScheme=Okta: This refers to your Okta username.
- AuthScheme=PingFederate: This refers to your PingFederate username.
ConnectionType=FTP(S)
- AuthScheme=Basic: This refers to your FTP(S) server username.
ConnectionType=HDFS/HDFS Secure
- AuthScheme=Negotiate: This refers to your HDFS intance username.
ConnectionType=HTTP(S)
- AuthScheme=Basic: This refers to the username associated with the HTTP stream.
- AuthScheme=Digest: This refers to the username associated with the HTTP stream.
- AuthScheme=OAuthPassword: This refers to the username associated with the HTTP stream.
ConnectionType=SharePoint SOAP
- AuthScheme=Basic: This refers to your SharePoint account username.
- AuthScheme=ADFS: This refers to your ADFS username.
- AuthScheme=Okta: This refers to your Okta username.
- AuthScheme=OneLogin: This refers to your OneLogin username.

Password

The password used to authenticate the user.

Data Type

string

Default Value

""

Remarks

The password associated with the authenticating user account (specified in the User connection property).

The User and Password connection properties, if they are applicable to the current ConnectionType and AuthScheme, are used together to authenticate to the service or platform containing your Microsoft Excel files.

This property will refer to different things based on the context, namely the value of ConnectionType and AuthScheme:

ConnectionType=AmazonS3
- AuthScheme=ADFS: This refers to your ADFS password.
- AuthScheme=Okta: This refers to your Okta password.
- AuthScheme=PingFederate: This refers to your PingFederate password.
ConnectionType=FTP(S)
- AuthScheme=Basic: This refers to your FTP(S) server password.
ConnectionType=HDFS/HDFS Secure
- AuthScheme=Negotiate: This refers to your HDFS intance password.
ConnectionType=HTTP(S)
- AuthScheme=Basic: This refers to the password associated with the HTTP stream.
- AuthScheme=Digest: This refers to the password associated with the HTTP stream.
- AuthScheme=OAuthPassword: This refers to the password associated with the HTTP stream.
ConnectionType=SharePoint SOAP
- AuthScheme=Basic: This refers to your SharePoint account password.
- AuthScheme=ADFS: This refers to your ADFS password.
- AuthScheme=Okta: This refers to your Okta password.
- AuthScheme=OneLogin: This refers to your OneLogin password.

SharePointEdition

*Note:* This property is deprecated and is scheduled for removal in the v27 release. It no longer affects the connection.

The edition of SharePoint being used. Set either SharePointOnline or SharePointOnPremise.

Possible Values

SharePointOnline, SharePointOnPremise

Data Type

string

Default Value

SharePointOnline

Remarks

This property is deprecated and is scheduled for removal in the v27 release.

The edition of SharePoint being used. Set either SharePointOnline or SharePointOnPremise.

Connection

This section provides a complete list of connection properties you can configure.

Property	Description
`ConnectionType`	Specifies the file storage service, server, or file access protocol through which your Microsoft Excel files are stored and retreived.
`URI`	A Uniform Resource Identifier (URI) to a resource location containing Excel workbook file(s).
`DefineTables`	A list of cell ranges within spreadsheets to model as tables.
`Header`	Specifies whether the first row (or column, when Orientation=Horizontal) is used as a source of column names.
`Orientation`	Indicates whether the data in Excel is laid out horizontally or vertically.
`BufferChanges`	Specifies whether to wait until the connection is closed to apply changes made to workbook data.
`Region`	The hosting region for your S3-like Web Services.
`OracleNamespace`	The Oracle Cloud Object Storage namespace to use.
`StorageBaseURL`	Specifies the URL of a cloud storage service provider.
`UseVirtualHosting`	If true (default), buckets will be referenced in the request using the hosted-style request: `http://yourbucket.s3.amazonaws.com/yourobject`. If set to false, the bean will use the path-style request: `http://s3.amazonaws.com/yourbucket/yourobject`. Note that this property will be set to false, in case of an S3 based custom service when the CustomURL is specified.
`TestConnectionBehavior`	Specifies the behavior of the test connection operation.
`UseLakeFormation`	When this property is set to true, AWSLakeFormation service will be used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through OKTA, ADFS, Microsoft Entra ID, PingFederate, while providing a SAML assertion.

ConnectionType

Specifies the file storage service, server, or file access protocol through which your Microsoft Excel files are stored and retreived.

Possible Values

Local, Amazon S3, Azure Blob Storage, Azure Data Lake Storage Gen2, Azure Data Lake Storage Gen2 SSL, Azure Files, Box, Dropbox, FTP, FTPS, Google Cloud Storage, Google Drive, HDFS, HDFS Secure, HTTP, HTTPS, IBM Object Storage Source, OneDrive, OneLake, Oracle Cloud Storage, SFTP, SharePoint GRAPH, SharePoint SOAP, SharePoint REST V1

Data Type

string

Default Value

Local

Remarks

Set the ConnectionType to one of the following:

Local: Microsoft Excel files stored on your local machine.
Amazon S3
Azure Blob Storage
Azure Data Lake Storage Gen2
Azure Data Lake Storage Gen2 SSL
Azure Files
Box
Dropbox
FTP
FTPS
Google Cloud Storage
Google Drive
HDFS
HDFS Secure
HTTP: Connects to Microsoft Excel files hosted on HTTP streams.
HTTPS: Connects to Microsoft Excel files hosted on HTTPS streams.
IBM Object Storage Source
OneDrive
OneLake
Oracle Cloud Storage
SFTP
SharePoint GRAPH
SharePoint SOAP
SharePoint REST V1

URI

A Uniform Resource Identifier (URI) to a resource location containing Excel workbook file(s).

Data Type

string

Default Value

""

Remarks

This connection property, alongside IncludeSubdirectories, specifies the selected workbook(s): the pool of workbook(s) whose spreadsheets the connector models as tables. The AggregateFiles connection property only operates on the workbook(s) in this pool (others are ignored).

If this connection property is set to the path of an individual workbook file, only the sheets from that workbook are listed as tables.

If this connection property is set to a folder path, sheets from all spreadsheets in that immediate folder, as well as nested folders (if IncludeSubdirectories is set to True) are listed as tables. The DirectoryRetrievalDepth connection property operates relative to this folder.

Example Connection Strings and Queries

Below are example connection strings to Excel files or streams.

Service Provider	URI Formats	Connection example
Local	`localPath` `file://localPath/file.xlsx`	URI=C:/folder1/file.xlsx
HTTP or HTTPS	`http://remoteStream` `https://remoteStream`	URI=http://www.host1.com/streamname1;
Amazon S3	`s3://bucket1/folder1/file.xlsx`	URI=s3://bucket1/folder1/file.xlsx; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO;
Google Drive	`gdrive://remotePath/file.xlsx`	URI=gdrive://folder1/file.xlsx;InitiateOAuth=GETANDREFRESH;
Box	`box://remotePath/file.xlsx`	URI=box://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;
FTP or FTPS	`ftp://server:port/remotePath/file.xlsx` `ftps://server:port/remotepath/file.xlsx`	URI=ftps://localhost:990/folder1/file.xlsx; User=user1; Password=password1;
SFTP	`sftp://server:port/remotePath/file.xlsx`	URI=sftp://127.0.0.1:22/remotePath/file.xlsx; User=user1; Password=password1;
Sharepoint	`sp://https://server/remotePath/file.xlsx`	URI=sp://https://domain.sharepoint.com/Documents/file.xlsx; User=user1; Password=password1;

The syntax for these additional rules is <Sheet Name>=<"Horizontal" or "Vertical">, where "Sheet Name" is the name of a sheet in one of the selected workbooks.

For example, a value of Orientation=Horizontal, Sheet1=Vertical means that the orientation is set to horizontal for all sheets except Sheet1, which is vertical. If there are multiple sheets across the selected workbooks that share the name "Sheet1", the same rule applies to all sheets by that name.

When this connection property is set to Horizontal, the Header connection property uses the rows in the first column, rather than the columns in the first row, as the source of column names for the sheet tables in the connector.

BufferChanges

Specifies whether to wait until the connection is closed to apply changes made to workbook data.

Data Type

bool

Default Value

true

Remarks

If this connection property is set to True, changes made to workbook data via the connector are applied when the connector's connection is closed.

If this connection property is set to False, changes are reflected in the affected workbook files immediately, though the repeated opening and closing of workbook files necessary to make these immediate updates causes a reduction in query performance.

Region

The hosting region for your S3-like Web Services.

Data Type

string

Default Value

""

Remarks

The hosting region for your S3-like Web Services.

Oracle Cloud Object Storage Regions

Value	Region
*Commercial Cloud Regions*
`ap-hyderabad-1`	India South (Hyderabad)
`ap-melbourne-1`	Australia Southeast (Melbourne)
`ap-mumbai-1`	India West (Mumbai)
`ap-osaka-1`	Japan Central (Osaka)
`ap-seoul-1`	South Korea Central (Seoul)
`ap-sydney-1`	Australia East (Sydney)
`ap-tokyo-1`	Japan East (Tokyo)
`ca-montreal-1`	Canada Southeast (Montreal)
`ca-toronto-1`	Canada Southeast (Toronto)
`eu-amsterdam-1`	Netherlands Northwest (Amsterdam)
`eu-frankfurt-1`	Germany Central (Frankfurt)
`eu-zurich-1`	Switzerland North (Zurich)
`me-jeddah-1`	Saudi Arabia West (Jeddah)
`sa-saopaulo-1`	Brazil East (Sao Paulo)
`uk-london-1`	UK South (London)
`us-ashburn-1` (default)	US East (Ashburn, VA)
`us-phoenix-1`	US West (Phoenix, AZ)
*US Gov FedRAMP High Regions*
`us-langley-1`	US Gov East (Ashburn, VA)
`us-luke-1`	US Gov West (Phoenix, AZ)
*US Gov DISA IL5 Regions*
`us-gov-ashburn-1`	US DoD East (Ashburn, VA)
`us-gov-chicago-1`	US DoD North (Chicago, IL)
`us-gov-phoenix-1`	US DoD West (Phoenix, AZ)

Wasabi Regions

Value	Region
`eu-central-1`	Europe (Amsterdam)
`us-east-1` (Default)	US East (Ashburn, VA)
`us-east-2`	US East (Manassas, VA)
`us-west-1`	US West (Hillsboro, OR)

OracleNamespace

The Oracle Cloud Object Storage namespace to use.

Data Type

string

Default Value

""

Remarks

The Oracle Cloud Object Storage namespace to use. This setting must be set to the Oracle Cloud Object Storage namespace associated with the Oracle Cloud account before any requests can be made. Refer to the Understanding Object Storage Namespaces page of the Oracle Cloud documentation for instructions on how to find your account's Object Storage namespace.

StorageBaseURL

Specifies the URL of a cloud storage service provider.

Data Type

string

Default Value

""

Remarks

This connection property is used to specify:

The URL of a custom S3 service.
The URL required for the SharePoint SOAP/REST cloud storage service provider.

If the domain for this option ends in -my (for example, https://bigcorp-my.sharepoint.com) then you may need to use the onedrive:// scheme instead of the sp:// or spgraph:// scheme.

When connecting to files in a non–root-level SharePoint Online site (for example, under /sites/<your site>/), set this property to the full site path. For example: StorageBaseURL=https://<your domain>.sharepoint.com/sites/<your site>/

Using the full SharePoint site URL ensures the connector can locate files stored in subsites or other non-root-level site structures.

UseVirtualHosting

If true (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.s3.amazonaws.com/yourobject. If set to false, the bean will use the path-style request: http://s3.amazonaws.com/yourbucket/yourobject. Note that this property will be set to false, in case of an S3 based custom service when the CustomURL is specified.

Data Type

bool

Default Value

true

Remarks

If true (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.s3.amazonaws.com/yourobject. If set to false, the bean will use the path-style request: http://s3.amazonaws.com/yourbucket/yourobject. Note that this property will be set to false, in case of an S3 based custom service when the CustomURL is specified.

TestConnectionBehavior

Specifies the behavior of the test connection operation.

Possible Values

READ_FILE, LIST_FILES, NO_OPERATION, AUTHENTICATE, LIST_OR_READ_FILES

Data Type

string

Default Value

LIST_OR_READ_FILES

Remarks

Changes how the connector responds to a test connection operation based on the integration scenario.

LIST_OR_READ_FILES

List and read files from the storage source until at least one is parsed. Fails if none of the files can be parsed (are invalid). Succeeds even if the directory contains no Microsoft Excel files since this provider supports creating files. Note: this mode will not read files in sub-directories. This is the most flexible option and works with both directory and file URIs.

READ_FILE

Validates that the URI points to a readable Microsoft Excel file. The URI must point to an existing Microsoft Excel file, not a directory. This behavior will fail if the file does not exist or contains invalid Microsoft Excel content.

LIST_FILES

Validates that the URI points to a directory and lists its contents. Succeeds even if the directory contains no Microsoft Excel files since this provider supports creating files.

NO_OPERATION

Performs basic URI validation without accessing files or verifying their existence. This is useful for quickly validating configuration without network or file system operations.

AUTHENTICATE

Validates connection credentials and URI accessibility. For cloud storage, this verifies authentication. For local files, this checks URI format and basic accessibility.

Notes

The connector supports creating new files during write operations. This means that empty or non-existing

directories do not cause connection test failures for most behaviors, as the connector assumes you may intend to create new files in those locations.

Behavior by URI examples

URI Type	NO_OPERATION	READ_FILE	LIST_FILES	LIST_OR_READ_FILES	AUTHENTICATE
Directory with excel files	Success	Failure: URI must point to an existing file	Success	Success	Success
Empty directory	Success	Failure: URI must point to an existing file	Success	Success	Success
Non-existing directory	Success	Failure: URI must point to an existing file	Success	Success	Success
Valid excel file	Success	Success	Failure: URI must point to an existing directory	Success	Success
Non-existing file	Success	Failure: URI must point to an existing file	Failure: URI must point to an existing directory	Failure: URI must point to valid file or directory	Success
Invalid excel content	Success	Failure: Parsing error	Failure: URI must point to an existing directory	Failure: Parsing error	Success
Cloud storage, invalid credentials	Success	Failure: Authentication failed	Failure: Authentication failed	Failure: Authentication failed	Failure: Authentication failed

UseLakeFormation

AWSCredentialsFile

The location of your credentials file.

Data Type

string

Default Value

""

Remarks

Set AuthScheme to AwsCredentialsFile and this property to the location of a credentials file to authenticate using any of the configurations supported by that file, including AccessKey/SecretKey authentication, temporary credentials, role authentication, or MFA. Use AWSCredentialsFileProfile to select which profile in the file to use.

For further information, see the AWS Command Line Interface User Guide.

AWSCredentialsFileProfile

The name of the profile you would like to use from the specified credentials file.

Data Type

string

Default Value

"default"

Remarks

This property is optional and only takes effect when AWSCredentialsFile is set. If not specified, the default profile in the credentials file is used.

TemporaryTokenDuration

The amount of time (in seconds) a temporary token will last.

Data Type

string

Default Value

3600

Remarks

Temporary tokens are used with both MFA and Role based authentication. Temporary tokens will eventually time out, at which time a new temporary token must be obtained. For situations where MFA is not used, this is not a big deal. The Jitterbit Connector for Microsoft Excel will internally request a new temporary token once the temporary token has expired.

""

Remarks

This property is typically set automatically via the AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE environment variable by the EKS Pod Identity Agent. If the environment variable is not available, specify the token file path using this property.

Azure Authentication

This section provides a complete list of Azure authentication properties you can configure.

Property	Description
`AzureStorageAccount`	The name of your Azure storage account.
`AzureAccessKey`	The storage key associated with your Azure account.
`AzureSharedAccessSignature`	A shared access key signature that may be used for authentication.
`AzureTenant`	Identifies the Microsoft Excel tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
`AzureEnvironment`	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

AzureStorageAccount

The name of your Azure storage account.

Data Type

string

Default Value

""

Remarks

To find the directory (tenant) ID in the Microsoft Entra Admin Center, navigate to Microsoft Entra ID > Properties and copy the value labeled "Directory (tenant) ID".

This property is required in the following cases:

When AuthScheme is Microsoft Entra ID and the user account belongs to multiple tenants

You can provide the tenant value in one of two formats:

A domain name (for example, contoso.onmicrosoft.com)
A directory (tenant) ID in GUID format (for example, c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0)

Specifying the tenant explicitly ensures that the authentication request is routed to the correct directory, which is especially important when a user belongs to multiple tenants or when using service principal–based authentication.

If this value is omitted when required, authentication may fail or connect to the wrong tenant. This can result in errors such as unauthorized or resource not found.

AzureEnvironment

Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

Data Type

string

Default Value

GLOBAL

Remarks

Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.

SSO

This section provides a complete list of SSO properties you can configure.

Property	Description
`SSOLoginURL`	The identity provider's login URL.
`SSOProperties`	Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
`SSOExchangeURL`	The URL used for consuming the SAML response and exchanging it for service specific credentials.

Remarks

The Jitterbit Connector for Microsoft Excel will use the URL specified here to consume a SAML response and exchange it for service specific credentials. The retrieved credentials are the final piece during the SSO connection that are used to communicate with Microsoft Excel.

Data

This section provides a complete list of the Data properties you can configure.

Property	Description
`AllowFormula`	Specifies whether to treat values starting with an equals (=) sign as formulas during inserts and updates.
`EmptyValueMode`	Specifies whether to read cells containing empty strings as empty or as null.
`NullValues`	Identifies a comma-separated list of values to read as null.
`IgnoreCalcError`	Specifies whether to include spreadsheet calculation error types in query results.
`NullValueMode`	Specifies whether unset cells are read as NULL or as empty strings.
`HasCrossSheetReferences`	Specifies how cross-sheet references are handled.
`Recalculate`	Specifies whether to recalculate formula values when cells involved in formula calculation are updated.
`ShowEmptyRows`	Determines whether empty rows are included in query results.
`TypeDetectionScheme`	Determines how the provider detects the data types of columns.
`EnableOleDbCompatibility`	Specifies whether to emulate how the Microsoft OLE DB Driver reports newline characters.
`UseFastInsert`	Indicates whether to use the efficient insert mode, which forces inserts to append new lines to the bottom of the spreadsheet.
`AggregateFiles`	Enables the ability to aggregate the content of identically-named sheets across multiple workbook files.
`SkipTop`	Specifies the number of rows (or columns, when Orientation=Horizontal) immediately after the header to omit from query results.
`IncludeCustomNames`	Indicates whether or not the defined names should be pushed.
`IncludeSubdirectories`	Indicates whether to include workbook files in subdirectories when list.
`MetadataDiscoveryURI`	Identifies the workbook that is used as the source of metadata when aggregating sheets with the AggregateFiles connection property.
`PathSeparator`	The character used to represent path separators when calculating the names of tables based on spreadsheets in nested folders.

AllowFormula

Specifies whether to treat values starting with an equals (=) sign as formulas during inserts and updates.

Data Type

bool

Default Value

true

Remarks

When this connection property is set to True, values starting with an equals sign (=) are treated as formulas when executing INSERT and UPDATE queries. The specified formula is embedded into the affected cell(s) and the result of the formula is returned in query results.

When this connection property is set to False, values starting with an equals sign (=) are treated as literal strings when executing INSERT and UPDATE queries.

To illustrate this, suppose you have the following sheet ...

ColA	ColB
`1`	5
`4`	6

... and you INSERT the following formula:

INSERT INTO Sheet1 (ColA,ColB) VALUES ("=SUM(A2:A3)","8"),

If this connection property is set to True, the sheet now contains:

ColA	ColB
`1`	5
`4`	6
5 (result of this cell's now-embedded formula: =SUM(A2:A3) )	8

If this connection property is set to False, the sheet now contains:

ColA	ColB
`1`	5
`4`	6
=SUM(A2:A3) (literal string)	8

EmptyValueMode

Specifies whether to read cells containing empty strings as empty or as null.

Possible Values

ReadAsEmpty, ReadAsNull

Data Type

string

Default Value

ReadAsEmpty

Remarks

An empty value is a cell which contains an empty string (e.g., ""). Empty values are different from cells that have not been set, which contain null values.

string

Default Value

ReadAsNull

Remarks

By default, unset cells appear as NULL in query results. This is different from cells that have been set to an empty value, or had their values removed. Use this property to control what the connector returns for unset Microsoft Excel cells.

Permitted values are:

ReadAsNull: Unset cells are reported as NULL.
ReadAsDefault: Unset cells are reported as empty strings.
ReadAsEmpty (Deprecated): If this value is currently set, update it to ReadAsDefault for equivalent behavior.
ReadAsEmptyOrNull: Unset cells in string columns are reported as empty strings, and unset cells in other columns are reported as NULL.

Set this connection property to one of the following:

Property	Description
`None`	Returns all columns as string type.
`RowScan`	Scans rows to determine the data type. The RowScanDepth determines the number of rows that the connector scans when determining the data type.
`ColumnFormat`	Reports the data type based on the cell format (Number, Currency, Date, etc.) of the column.
`ColumnStyle`	Scans rows to determine the data type. The RowScanDepth determines the number of rows to be scanned. This retrieves more specific data types (date / time instead of just timestamp), but is more likely to cause values to be truncated due to values in the cells not completely following the associated conventions for those types.

To facilitate aggregation of identically-named sheets, a metadata source workbook must be selected. The connector models each sheet from this workbook as an aggregate sheet table named after that sheet.

Each aggregate sheet table contains the combined content of all sheets that share the same name, across all selected workbooks.

You can explicitly designate a workbook file as the metadata source workbook with the MetadataDiscoveryURI connection property. If MetadataDiscoveryURI is not set, the first workbook file in the directory specified by the URI connection property is used as the metadata source workbook.

For example, if the metadata source workbook has a sheet named "SheetA", with this content:

ColA	ColB	ColC
1	2	3

and another workbook also has a sheet named "SheetA", with this content:

ColA	ColB	ColC
4	5	6

then the connector would expose a single tabled called "SheetA", and querying this table would produce this aggregate result:

ColA	ColB	ColC
1	2	3
4	5	6

Considerations

If any sheets contributing to the aggregate sheet table lack columns present in the metadata source workbook's instance of that sheet, the missing columns return null values in the aggregate sheet table.
Workbook files that don't share any sheet names with the metadata source workbook are not included in aggregation sheet table records and are not exposed as separate tables.
When this connection property is set to False, each sheet in each of the workbooks selected with URI and IncludeSubdirectories is exposed as its own table.

SkipTop

Specifies the number of rows (or columns, when Orientation=Horizontal) immediately after the header to omit from query results.

Data Type

int

Default Value

0

Remarks

This connection property omits the specified the number of rows, among the rows immediately following the header row, to omit query results.

""

Remarks

When the AggregateFiles connection property is enabled, the connector aggregates the content of identically-named sheets from multiple workbook files into consolidated tables called aggregate sheet tables.

To facilitate aggregation of identically-named sheets, a metadata source workbook must be selected. The connector models each sheet from this workbook as an aggregate sheet table named after that sheet.

You can use this connection property to explicitly designate a workbook file as the metadata source workbook. If this connection property is not set, the first workbook file in the directory is used as the metadata source workbook.

The path that you specify for the metadata source workbook is resolved as follows:

Relative path: resolved relative to the directory of the connection URI (the folder being aggregated).
Absolute local path: a local path that starts with /, \, or a drive letter followed by a separator (for example, C:\ or C:/), optionally prefixed with file://, is always allowed, even when the connection points to cloud storage. In this case, the connector reads the metadata source workbook from the local file system while the sheet data is read from the configured storage. Drive-relative values such as C: or C:dev are not treated as absolute paths.
Absolute URI with a scheme: an absolute URI that includes a scheme (for example, s3://, gs://, or azureblob://) must point to the same storage as the connection. If its scheme does not match the connection's storage type, the connection fails with a configuration error.

PathSeparator

The character used to represent path separators when calculating the names of tables based on spreadsheets in nested folders.

Data Type

string

Default Value

_

Remarks

The character used to separate path components in such scenarios is taken from the value of this connection property. By default, this separator character is "_".

When the URI connection property is set to a folder, and the IncludeSubdirectories connection property is set to True, workbooks in nested folders are included in the pool of workbooks whose spreadsheets the connector models as tables.

Tables based on spreadsheets in workbooks inside nested folders include the names of all path components relative to the folder specified in URI.

For example, suppose the following:

The URI is set to C:/Workbooks, and
IncludeSubdirectories is set to True, and
There is a workbook file called "MyWorkbook.xlsx" with a sheet called "MySheet" in a folder called C:/Workbooks/NestedWorkbooks.

The connector, by default, calls the resulting table for the "MySheet" sheet: NestedWorkbooks_MyWorkbook.xlsx.MySheet

Note that this includes a character ("_") separating the nested folder ("NestedWorkbooks") and the workbook ("MyWorkbook.xlsx") therein.

This separator applies to an arbitrary number of nested folder levels (as far as the DirectoryRetrievalDepth connection property's value allows).

OAuth

This section provides a complete list of OAuth properties you can configure.

Property	Description
`InitiateOAuth`	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
`OAuthVersion`	Identifies the version of OAuth being used.
`OAuthClientId`	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
`OAuthClientSecret`	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
`OAuthAccessToken`	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
`OAuthAccessTokenSecret`	The OAuth access token secret for connecting using OAuth.
`OAuthSettingsLocation`	Specifies the location of the settings file where OAuth values are saved.
`CallbackURL`	Identifies the URL users return to after authenticating to Microsoft Excel via OAuth (Custom OAuth applications only).
`Scope`	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
`OAuthPasswordGrantMode`	Specifies how the OAuth Client ID and Client Secret are sent to the authorization server.
`OAuthIncludeCallbackURL`	Whether to include the callback URL in an access token request.
`OAuthAuthorizationURL`	The authorization URL for the OAuth service.
`OAuthAccessTokenURL`	The URL from which the OAuth access token is retrieved.
`OAuthRefreshTokenURL`	The URL to refresh the OAuth token from.
`OAuthRequestTokenURL`	The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0.
`OAuthVerifier`	Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
`AuthToken`	The authentication token used to request and obtain the OAuth Access Token.
`AuthKey`	The authentication secret used to request and obtain the OAuth Access Token.
`OAuthParams`	A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
`OAuthRefreshToken`	Specifies the OAuth refresh token used to request a new access token after the original has expired.
`OAuthExpiresIn`	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
`OAuthTokenTimestamp`	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

OFF

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for:

Logging in users.
Exchanging user credentials for an OAuth access token to be used for authentication.
Providing limited access to applications.

The options for initiating and maintaining OAuth access are named for the parts of that flow that the connector handles:

OFF	The connector provides no automatic OAuth flow initiation. The OAuth flow is handled entirely by the user. This means that the user must refresh the token manually, and reconnect with an updated OAuthAccessToken property when the current token expires.
GETANDREFRESH	The connector handles the entire OAuth flow (both GET and REFRESH). This means that if a token already exists, the connector refreshes it when necessary; if no token currently exists, the connector obtains it by prompting the user to login.
REFRESH	The user obtains the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate.) After the user logs in, the connector handles the refresh of the OAuth Access Token.

OAuthVersion

Identifies the version of OAuth being used.

Possible Values

1.0, 2.0

Data Type

string

Default Value

2.0

Remarks

Accepted entries are: 1.0,2.0

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

The OAuthAccessTokenSecret property is used to connect and authenticate using OAuth. The OAuthAccessTokenSecret is retrieved from the OAuth server as part of the authentication process. It is used with the OAuthAccessToken and can be used for multiple requests until it times out.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\CData\Excel Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\CData\Excel Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

Windows: "register://%DSN"
Unix: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

Platform	%APPDATA%
`Windows`	The value of the APPDATA environment variable
`Linux`	~/.config

Default Value

Post

Remarks

The OAuth RFC provides two methods of passing the OAuthClientId and OAuthClientSecret:

POST: Sends the OAuthClientId and OAuthClientSecret in the POST body of the token request. This is the most commonly supported method and works with most OAuth flows.
BASIC: Sends the OAuthClientId and OAuthClientSecret in the HTTP Authorization header using Basic authentication. Some OAuth servers require this method for added compliance or security.

OAuthIncludeCallbackURL

Whether to include the callback URL in an access token request.

Data Type

bool

Default Value

true

Remarks

It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

AuthKey

The authentication secret used to request and obtain the OAuth Access Token.

Data Type

string

Default Value

""

Remarks

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

OAuthParams

A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.

Data Type

string

Default Value

""

Remarks

A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.

OAuthRefreshToken

Specifies the OAuth refresh token used to request a new access token after the original has expired.

Data Type

string

Default Value

""

Remarks

The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.

The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessTokenproc; stored procedure if you prefer to manage the refresh manually.

When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.

Note

The OAuthRefreshToken should be handled securely and stored in a trusted location.

Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.

OAuthExpiresIn

Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.

To determine how long the user has before the Access Token will expire, check OAuthTokenTimestamp.

OAuthTokenTimestamp

Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

Data Type

string

Default Value

""

Remarks

The OAuth access token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

JWT OAuth

This section provides a complete list of JWT OAuth properties you can configure.

Property	Description
`OAuthJWTCert`	Supplies the name of the client certificate's JWT Certificate store.
`OAuthJWTCertType`	Identifies the type of key store containing the JWT Certificate.
`OAuthJWTCertPassword`	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
`OAuthJWTCertSubject`	Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
`OAuthJWTIssuer`	The issuer of the Java Web Token.
`OAuthJWTSubject`	The user subject for which the application is requesting delegated access.

OAuthJWTCert

Supplies the name of the client certificate's JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates.

If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the Jitterbit Connector for Microsoft Excel initiates a search for a certificate. For further information, see OAuthJWTCertSubject.

Designations of certificate stores are platform-dependent.

Notes

The most common User and Machine certificate stores in Windows include:
- MY: A certificate store holding personal certificates with their
  
  associated private keys.
- CA: Certifying authority certificates.
- ROOT: Root certificates.
- SPC: Software publisher certificates.
- In Java, the certificate store normally is a file containing certificates and optional private keys.
- When the certificate store type is PFXFile, this property must be set to the name of the file.
- When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

OAuthJWTCertType

Identifies the type of key store containing the JWT Certificate.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB, BCFKSFILE, BCFKSBLOB, GOOGLEJSON, GOOGLEJSONBLOB, BOXJSON, BOXJSONBLOB

Data Type

string

Default Value

USER

Remarks

Value	Description	Notes
USER	A certificate store owned by the current user.	Only available in Windows.
MACHINE	A machine store.	Not available in Java or other non-Windows environments.
PFXFILE	A PFX (PKCS12) file containing certificates.
PFXBLOB	A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	A Java key store (JKS) file containing certificates.	Only available in Java.
JKSBLOB	A string (base-64-encoded) representing a certificate store in Java key store (JKS) format.	Only available in Java.
PEMKEY_FILE	A PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	A string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	A file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	A file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	A string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	A PKCS7 file containing certificates.
PPKFILE	A file that contains a PPK (PuTTY Private Key).
XMLFILE	A file that contains a certificate in XML format.
XMLBLOB	Astring that contains a certificate in XML format.
BCFKSFILE	A file that contains an Bouncy Castle keystore.
BCFKSBLOB	A string (base-64-encoded) that contains a Bouncy Castle keystore.
GOOGLEJSON	A JSON file containing the service account information.	Only valid when connecting to a Google service.
GOOGLEJSONBLOB	A string that contains the service account JSON.	Only valid when connecting to a Google service.
BOXJSON	A JSON file containing the service account credentials.	Only valid when connecting to Box.
BOXJSONBLOB	The certificate store is a string that contains the service account JSON.	Only valid when connecting to Box.

OAuthJWTCertPassword

Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.

Data Type

string

Default Value

""

Remarks

This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.

OAuthJWTCertSubject

Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Data Type

string

Default Value

*

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

If an exact match for the subject is found, the corresponding certificate is selected.
If no exact match is found, the store is searched for certificates whose subjects contain the property value.
If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, E=example@jbexample.com.

Common fields include:

Field	Meaning
`CN`	Common Name. This is commonly a host name like www.server.com.
`O`	Organization
`OU`	Organizational Unit
`L`	Locality
`S`	State
`C`	Country
`E`	Email Address

If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".

OAuthJWTIssuer

The issuer of the Java Web Token.

Data Type

string

Default Value

""

Remarks

The issuer of the Java Web Token. In most cases, this takes the value of the OAuth App ID (Client Id) connection property and does not need to be individually set.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.

OAuthJWTSubject

The user subject for which the application is requesting delegated access.

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. In most cases, this takes the value of the OAuth App ID (Client Id) connection property and does not need to be individually set.

Kerberos

This section provides a complete list of Kerberos properties you can configure.

Property	Description
`KerberosKDC`	Identifies the Kerberos Key Distribution Center (KDC) service used to authenticate the user. (SPNEGO or Windows authentication only).
`KerberosRealm`	Identifies the Kerberos Realm used to authenticate the user.
`KerberosSPN`	Identifies the service principal name (SPN) for the Kerberos Domain Controller.
`KerberosUser`	Confirms the principal name for the Kerberos Domain Controller, which uses the format host/user@realm.
`KerberosKeytabFile`	Identifies the Keytab file containing your pairs of Kerberos principals and encrypted keys.
`KerberosServiceRealm`	Identifies the service's Kerberos realm. (Cross-realm authentication only).
`KerberosServiceKDC`	Identifies the service's Kerberos Key Distribution Center (KDC).
`KerberosTicketCache`	Specifies the full file path to an MIT Kerberos credential cache file.

KerberosKDC

Identifies the Kerberos Key Distribution Center (KDC) service used to authenticate the user. (SPNEGO or Windows authentication only).

Data Type

string

Default Value

""

Remarks

The Kerberos properties are used when using SPNEGO or Windows Authentication. The connector requests session tickets and temporary session keys from the Kerberos KDC service, which is usually co-located with the domain controller.

Note

Windows authentication is supported in JRE 1.6 and above only.

If KerberosKDC is not specified, the connector tries to detect these properties automatically from the following locations:

KRB5 Config File (krb5.ini/krb5.conf): If the KRB5_CONFIG environment variable is set and the file exists, the connector obtains the KDC from the specified file. If it is not found there, the connector tries to read from the default MIT location based on the OS: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) or /etc/krb5.conf (Linux).
Java System Properties: Using the system properties java.security.krb5.realm and java.security.krb5.kdc.
Domain Name and Host: If the Kerberos Realm and Kerberos KDC cannot be inferred from another location, the connector infers them from the configured domain name and host.

KerberosRealm

Identifies the Kerberos Realm used to authenticate the user.

Data Type

string

Default Value

""

Remarks

A realm is a logical network, similar to a domain, that defines a group of systems under the same master KDC. Some realms are hierarchical, where one realm is a superset of the other realm, but usually realms are nonhierarchical (or “direct”) and the mapping between the two realms must be defined. Kerberos cross-realm authentication enables authentication across realms. Each realm only needs to have a principal entry for the other realm in its KDC.

The Kerberos properties are used when using SPNEGO or Windows Authentication. The connector requests session tickets and temporary session keys from the Kerberos KDC service, which is usually co-located with the domain controller. The Kerberos Realm can be configured by an administrator to be any string, but it is usually based on the domain name.

If Kerberos Realm is not specified, the connector will attempt to detect these properties automatically from the following locations:

KRB5 Config File (krb5.ini/krb5.conf): If the KRB5_CONFIG environment variable is set and the file exists, the connector will obtain the default realm from the specified file. Otherwise, it will attempt to read from the default MIT location based on the OS: C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) or /etc/krb5.conf (Linux)
Java System Properties: Using the system properties java.security.krb5.realm and java.security.krb5.kdc.
Domain Name and Host: If the Kerberos Realm and Kerberos KDC could not be inferred from another location, the connector will infer them from the user-configured domain name and host. This might work in some Windows environments.

Remarks

A keytab (short for “key table”) stores long-term keys for one or more principals. In most cases, end users authenticate to the KDC using their client secret (password). However, in situations where authentication or re-authentication happen using automated scripts and applications, it may be more efficient to use a keytab, which sends passwords to the KDC in encrypted form, automatically.

Keytabs are normally represented by files in a standard format, and named using the format type:value. Usually type is FILE and value is the absolute pathname of the file. The other possible value for type is MEMORY, which indicates a temporary keytab stored in the memory of the current process.

A keytab contains one or more entries, where each entry consists of a timestamp (indicating when the entry was written to the keytab), a principal name, a key version number, an encryption type, and the encryption key itself. They can be generated using kutil.

For example:

[admin@myhost]# ktutil

ktutil: addent -password -p starlord/myhost.galaxy.com@GALAXY.COM -k 1 -e aes256-cts-hmac-sha1-96
Password for starlord/myhost.galaxy.com:

ktutil: addent -password -p starlord/myhost.galaxy.com@GALAXY.COM -k 1 -e aes128-cts-hmac-sha1-96
Password for starlord/myhost.galaxy.com:

ktutil: addent -password -p starlord/myhost.galaxy.com@GALAXY.COM -k 1 -e des3-cbc-sha1
Password for starlord/myhost.galaxy.com:
ktutil: wkt /path/to/starlord.keytab

Note

You must create principals for all authentication methods (encryption types) you want to support.

To display a keytab, use klist -k.

A keytab (short for “key table”) stores long-term keys for one or more principals. In most cases, end users authenticate to the KDC using their client secret (password). However, in situations where authentication or re-authentication happen using automated scripts and applications, it may be more efficient to use a keytab, which sends passwords to the KDC in encrypted form, automatically.

Keytabs are normally represented by files in a standard format, and named using the format type:value. Usually type is FILE and value is the absolute pathname of the file. The other possible value for type is MEMORY, which indicates a temporary keytab stored in the memory of the current process.

A keytab contains one or more entries, where each entry consists of a timestamp (indicating when the entry was written to the keytab), a principal name, a key version number, an encryption type, and the encryption key itself. They can be generated using kutil.

For example:

[admin@myhost]# ktutil

ktutil: addent -password -p starlord/myhost.galaxy.com@GALAXY.COM -k 1 -e aes256-cts-hmac-sha1-96
Password for starlord/myhost.galaxy.com:

ktutil: addent -password -p starlord/myhost.galaxy.com@GALAXY.COM -k 1 -e aes128-cts-hmac-sha1-96
Password for starlord/myhost.galaxy.com:

ktutil: addent -password -p starlord/myhost.galaxy.com@GALAXY.COM -k 1 -e des3-cbc-sha1
Password for starlord/myhost.galaxy.com:
ktutil: wkt /path/to/starlord.keytab

Remarks

Set this property if you want to use a credential cache file that was created using the MIT Kerberos Ticket Manager or kinit command.

SSL

This section provides a complete list of SSL properties you can configure.

Property	Description
`SSLClientCert`	Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
`SSLClientCertType`	Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
`SSLClientCertPassword`	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
`SSLClientCertSubject`	Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
`SSLMode`	The authentication mechanism to be used when connecting to the FTP or FTPS server.
`SSLServerCert`	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLClientCert

Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.

Data Type

string

Default Value

""

Remarks

This property specifies the client certificate store for SSL Client Authentication. Use this property alongside SSLClientCertType, which defines the type of the certificate store, and SSLClientCertPassword, which specifies the password for password-protected stores. When SSLClientCert is set and SSLClientCertSubject is configured, the driver searches for a certificate matching the specified subject.

Certificate store designations vary by platform. On Windows, certificate stores are identified by names such as MY (personal certificates), while in Java, the certificate store is typically a file containing certificates and optional private keys.

The following are designations of the most common User and Machine certificate stores in Windows:

Property	Description
`MY`	A certificate store holding personal certificates with their associated private keys.
`CA`	Certifying authority certificates.
`ROOT`	Root certificates.
`SPC`	Software publisher certificates.

For PFXFile types, set this property to the filename. For PFXBlob types, set this property to the binary contents of the file in PKCS12 format.

SSLClientCertType

The subject should follow the standard format of a comma-separated list of distinguished name fields and values. For example, CN=www.server.com, OU=Test, C=US. Common fields include the following:

Field	Meaning
`CN`	Common Name. This is commonly a host name like www.server.com.
`O`	Organization
`OU`	Organizational Unit
`L`	Locality
`S`	State
`C`	Country
`E`	Email Address

Note

If any field contains special characters, such as commas, the value must be quoted. For example: CN="Example, Inc.", C=US.

SSLMode

The authentication mechanism to be used when connecting to the FTP or FTPS server.

Possible Values

AUTOMATIC, NONE, IMPLICIT, EXPLICIT

Data Type

string

Default Value

AUTOMATIC

Remarks

If SSLMode is set to NONE, default plaintext authentication is used to log in to the server. If SSLMode is set to IMPLICIT, the SSL negotiation will start immediately after the connection is established. If SSLMode is set to EXPLICIT, the connector will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS. If SSLMode is set to AUTOMATIC, if the remote port is set to the standard plaintext port of the protocol (where applicable), the component will behave the same as if SSLMode is set to EXPLICIT. In all other cases, SSL negotiation will be IMPLICIT.

AUTOMATIC
NONE
IMPLICIT
EXPLICIT

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
A path to a local file containing the certificate	`C:\\cert.cer`
The public key (example shortened for brevity)	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	`ecadbdda5a1529c58a1e9e09828d70e4`
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Note

It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

SSH

This section provides a complete list of SSH properties you can configure.

Property	Description
`SSHAuthMode`	The authentication method used when establishing an SSH Tunnel to the service.
`SSHClientCert`	A certificate to be used for authenticating the SSHUser.
`SSHClientCertPassword`	The password of the SSHClientCert key if it has one.
`SSHClientCertSubject`	The subject of the SSH client certificate.
`SSHClientCertType`	The type of SSHClientCert private key.
`SSHUser`	The SSH user.
`SSHPassword`	The SSH password.

Default Value

*

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=example@jbexample.com". Common fields and their meanings are displayed below.

Field	Meaning
`CN`	Common Name. This is commonly a host name like www.server.com.
`O`	Organization
`OU`	Organizational Unit
`L`	Locality
`S`	State
`C`	Country
`E`	Email Address

If a field value contains a comma it must be quoted.

SSHClientCertType

The type of SSHClientCert private key.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PPKFILE, PPKBLOB, XMLFILE, XMLBLOB

Data Type

string

Default Value

PEMKEY_FILE

Remarks

This property can take one of the following values:

Types	Description	Allowed Blob Values
MACHINE/USER	Not available on this platform.	Blob values are not supported.
JKSFILE/JKSBLOB	A Java keystore file. Must contain both a certificate and a private key. Only available in Java.	base64-only
PFXFILE/PFXBLOB	A PKCS12-format (.pfx) file. Must contain both a certificate and a private key.	base64-only
PEMKEY_FILE/PEMKEY_BLOB	A PEM-format file. Must contain an RSA, DSA, or OPENSSH private key. Can optionally contain a certificate matching the private key.	base64 or plain text.
PPKFILE/PPKBLOB	A PuTTY-format private key created using the `puttygen` tool.	base64-only
XMLFILE/XMLBLOB	An XML key in the format generated by the .NET RSA class: `RSA.ToXmlString(true)`.	base64 or plain text.

SSHUser

The SSH user.

Data Type

string

Default Value

""

Remarks

The SSH user.

SSHPassword

The SSH password.

Data Type

string

Default Value

""

Remarks

The SSH password.

Logging

This section provides a complete list of the logging properties you can configure in the connection string for this connector.

Property	Description
`Logfile`	A filepath which designates the name and location of the log file.
`Verbosity`	The verbosity level that determines the amount of detail included in the log file.
`LogModules`	Core modules to be included in the log file.
`MaxLogFileSize`	A string specifying the maximum size in bytes for a log file (for example, 10 MB).
`MaxLogFileCount`	A string specifying the maximum file count of log files.

Logfile

A filepath which designates the name and location of the log file.

Data Type

string

Default Value

""

Remarks

Once this property is set, the connector populates the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file does not already exist, the connector creates it.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

For more control over what is written to the log file, adjust the Verbosity property.

Log contents are categorized into several modules. Use the LogModules property to show or hide individual modules.

To edit the maximum size of a single log file before a new one is created, see MaxLogFileSize. To place a cap on the number of log files generated, use MaxLogFileCount.

Verbosity

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the connector reports to the Logfile. Verbosity levels 1 through 5 are supported:

Level	Detail Logged
`1`	The query, the number of rows returned by it, the start of execution and the time taken, and any errors.
`2`	Everything included in verbosity `1`, plus additional information about the request.
`3`	Everything included in verbosity `2`, plus the body of the request and the response.
`4`	Everything included in verbosity `3`, plus transport-level communication with the data source, including SSL negotiation.
`5`	Everything included in verbosity `4`, plus communication with the data source and additional details that may be helpful in troubleshooting problems.

When the limit is reached, the connector creates a new log in the same folder with the date and time appended to the file name, and deletes the oldest log file.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the log files generated with MaxLogFileSize.

Schema

This section provides a complete list of schema properties you can configure.

Property	Description
`Location`	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
`BrowsableSchemas`	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC .
`Tables`	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC .
`Views`	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

%APPDATA%\Excel Data Provider\Schema

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\Excel Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:

Platform	%APPDATA%
`Windows`	The value of the APPDATA environment variable
`Mac`	~/Library/Application Support
`Linux`	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note

If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note

If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property	Description
`AWSCertificate`	The absolute path to the certificate file or the certificate content in PEM format encoded in base64.
`AWSCertificatePassword`	The password for the certificate if applicable, otherwise leave blank.
`AWSCertificateType`	The type of AWSCertificate .
`AWSPrivateKey`	The absolute path to the private key file or the private key content in PEM format encoded in base64.
`AWSPrivateKeyPassword`	The password for the private key if it is encrypted, otherwise leave blank.
`AWSPrivateKeyType`	The type of AWSPrivateKey .
`AWSProfileARN`	Profile to pull policies from.
`AWSSessionDuration`	Duration, in seconds, for the resulting session.
`AWSTrustAnchorARN`	Trust anchor to use for authentication.
`Charset`	Specifies the session character set for encoding and decoding character data transferred to and from the Microsoft Excel file. The default value is UTF-8.
`ClientCulture`	This property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'.
`Culture`	This setting can be used to specify culture settings that determine how the provider interprets certain data types that are passed into the provider. For example, setting Culture='de-DE' will output German formats even on an American machine.
`CustomHeaders`	Specifies additional HTTP headers to append to the request headers created from other properties, such as ContentType and From. Use this property to customize requests for specialized or nonstandard APIs.
`CustomURLParams`	A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.
`DirectoryRetrievalDepth`	Specifies how many levels of subfolders are scanned when IncludeSubdirectories is enabled.
`ExcludeFiles`	A comma-separated list of filters to exclude from the set of files.
`FolderId`	The ID of a folder in Google Drive. If set, the resource location specified by the URI is relative to the Folder ID for all operations.
`GenerateSchemaFiles`	Indicates the user preference as to when schemas should be generated and saved.
`IncludeDropboxTeamResources`	Indicates if you want to include Dropbox team files and folders.
`IncludeFiles`	A comma-separated list of filters to include from the set of files.
`IncludeItemsFromAllDrives`	Whether Google Drive shared drive items should be included in results. If not present or set to false, then shared drive items are not returned.
`MaxRows`	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
`Other`	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
`PseudoColumns`	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
`RowScanDepth`	The maximum number of rows to scan to look for the columns available in a table.
`StringDecode`	Specifies whether hexadecimal characters are decoded in query results.
`Timeout`	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
`UserDefinedViews`	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
`UseSimpleNames`	Specifies whether or not simple names should be used for schemas, tables and columns.

Remarks

This property can take one of the following values:

Property	Description
`PEM_FILE`	Absolute path to a certificate file in PEM format.
`PEM_BLOB`	A string (base64-encoded) representing a PEM-encoded certificate.

Remarks

This property can take one of the following values:

Property	Description
`PEM_FILE`	Absolute path to a private key file in PEM format.
`PEM_BLOB`	A string (base64-encoded) representing a PEM-encoded private key.

Remarks

This connection property only takes effect if the URI connection property is set to a folder, rather than a workbook file.

The URI and IncludeSubdirectories connection properties determine which folders the connector sources workbooks from when listing metadata.

By default, all workbooks in the specified folders are used to calculate metadata.

However, using this connection property, you can refine this list further to ignore certain workbook files based on filters. If you want to use multiple filters, you can provide them in a comma-separated list.

Supported filters include:

Filename filters (wildcards supported). For example, October*.xlsx ignores all .xlsx files whose names start with "October".
Creation date filters. The syntax for these filters is CreatedDate<comparison operator><timestamp>. For example, CreatedDate<=2020-11-26T07:39:34-05:00 ignores all workbook files created before November 26th 2020.
Modified date filters. The syntax for these filters is CreatedDate<comparison operator><timestamp>. For example, ModifiedDate<=2020-11-26T07:39:34-05:00 ignores all workbook files modified before November 26th 2020.

The connector also supports the use of DATE Functions to calculate portions of date filters. For example:

ModifiedDate>=DATETIMEFROMPARTS(2020, 11, 26, 7, 40, 49, 000),ModifiedDate<=CURRENT_TIMESTAMP()

FolderId

The ID of a folder in Google Drive. If set, the resource location specified by the URI is relative to the Folder ID for all operations.

Data Type

string

Default Value

""

Remarks

The ID of a folder in Google Drive. If set, the resource location specified by the URI is relative to the Folder ID for all operations.

GenerateSchemaFiles

Indicates the user preference as to when schemas should be generated and saved.

Possible Values

Never, OnUse, OnStart, OnCreate

Data Type

string

Default Value

Never

Remarks

This property outputs schemas to .rsd files in the path specified by Location.

Available settings are the following:

Never: A schema file will never be generated.
OnUse: A schema file will be generated the first time a table is referenced, provided the schema file for the table does not already exist.
OnStart: A schema file will be generated at connection time for any tables that do not currently have a schema file.
OnCreate: A schema file will be generated by when running a CREATE TABLE SQL query.

Note that if you want to regenerate a file, you will first need to delete it.

Generate Schemas with SQL

When you set GenerateSchemaFiles to OnUse, the connector generates schemas as you execute SELECT queries. Schemas are generated for each table referenced in the query.

When you set GenerateSchemaFiles to OnCreate, schemas are only generated when a CREATE TABLE query is executed.

Generate Schemas on Connection

Another way to use this property is to obtain schemas for every table in your database when you connect. To do so, set GenerateSchemaFiles to OnStart and connect.

IncludeDropboxTeamResources

Indicates if you want to include Dropbox team files and folders.

Data Type

bool

Default Value

false

Remarks

In order to access Dropbox team folders and files, please set this connection property to True.

IncludeFiles

A comma-separated list of filters to include from the set of files.

Data Type

string

Default Value

*

Remarks

This connection property only takes effect if the URI connection property is set to a folder, rather than a workbook file.

The URI and IncludeSubdirectories connection properties determine which folders the connector sources workbooks from when listing metadata.

By default, all workbooks in the specified folders are used to calculate metadata.

However, using this connection property, you can refine this list further to only include certain workbook files based on filters. If you want to use multiple filters, you can provide them in a comma-separated list.

Supported filters include:

Filename filters (wildcards supported). For example, October*.xlsx includes all .xlsx files whose names start with "October".
Creation date filters. The syntax for these filters is CreatedDate<comparison operator><timestamp>. For example, CreatedDate<=2020-11-26T07:39:34-05:00 includes all workbook files created before November 26th 2020.
Modified date filters. The syntax for these filters is CreatedDate<comparison operator><timestamp>. For example, ModifiedDate<=2020-11-26T07:39:34-05:00 includes all workbook files modified before November 26th 2020.

The connector also supports the use of DATE Functions to calculate portions of date filters. For example:

ModifiedDate>=DATETIMEFROMPARTS(2020, 11, 26, 7, 40, 49, 000),ModifiedDate<=CURRENT_TIMESTAMP()

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note

It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Integration and Formatting

Property	Description
`DefaultColumnSize`	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
`ConvertDateTimeToGMT=True`	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
`RecordToFile=filename`	Records the underlying socket data transfer to the specified file.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note

Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Sheet WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the connector only sees that view.

For further information, see User Defined Views.

UseSimpleNames

Specifies whether or not simple names should be used for schemas, tables and columns.

Data Type

bool

Default Value

false

Remarks

Microsoft Excel schemas, tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the connector easier to use with traditional database tools.

Setting UseSimpleNames to true simplifies the names of schemas, tables or columns returned. It also enforces a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed column names.

Any non-alphanumeric characters are converted to underscores.