Microsoft Excel v2 Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8858 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.

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.xlsx or ftps://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

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 HMAC:

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 to the folder to be used as the root folder. 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 REST or SharePoint SOAP.
URI: Set this to a document library containing Excel files. For example:
- SharePoint Online REST: sprest://remotePath/file.xlsx
- SharePoint Online SOAP: sp://remotePath/file.xlsx

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

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 go 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)
MFA
Temporary Credentials
Credentials File

Root Credentials

To authenticate using account root credentials, set these configuration parameters:

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

Note

Use of this authentication scheme is discouraged by Amazon for anything but simple tests. The account root credentials have the full permissions of the user, making this the least secure authentication method.

EC2 Instances

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 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.

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.

{: #section}

AWS IAM Roles

Set AuthScheme to AwsIAMRoles.

In many situations, it may be preferable to use an IAM role for authentication instead of the direct security credentials of an AWS root user. If you are specifying the AWSAccessKey and AWSSecretKey of an AWS root user, you may not use roles.

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.

ADFS

To connect to ADFS, set the AuthScheme to ADFS, and set these properties:

User: The ADFS user.
Password: The ADFS user's password.
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 the AuthScheme to Okta, and set these properties:

User: The Okta user.
Password: The Okta user's password.
SSOLoginURL: The SSO provider's login URL.

If you are 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;

To connect to PingFederate, set AuthScheme to PingFederate, and set these properties:

User: The PingFederate user.
Password: The PingFederate user's 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): Authscheme=Basic if you want to include your username and password as an authorization header in requests to Amazon S3.

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;

Multi-Factor Authentication (MFA)

For users and roles that require multi-factor authentication, specify the following:

AuthScheme: AwsMFA.
CredentialsLocation: The location of the settings file where MFA credentials are saved. See the Credentials File Location page under Connection String Options for more information.
MFASerialNumber: The serial number of the MFA device if one is being used.
MFAToken: The temporary token available from your MFA device.

If you are connecting to AWS (instead of already being connected such as on an EC2 instance), you must additionally specify the following:

AWSAccessKey: The access key of the IAM user for whom MFA will be issued.
AWSSecretKey: The secret key of the IAM user whom MFA will be issued.

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 will cause the connector to attempt to retrieve credentials for the specified role using MFA.
AWSExternalId (optional): Only required if you are assuming a role in another AWS account.

This causes the connector to submit the MFA credentials in a 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).

Temporary Credentials

To authenticate using temporary credentials, specify the following:

AuthScheme: AwsTempCredentials.
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.
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: Specify 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.

Credentials Files

You can use a credentials file to authenticate. Any configurations related to AccessKey/SecretKey authentication, temporary credentials, role authentication, or MFA can be used. To do so, set the following properties to authenticate:

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 details, see AWS Command Line Interface User Guide.

Microsoft Entra ID

This configuration requires two separate 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 AzureAD, 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=AzureAD;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 AzureAD in all user account flows.

Desktop Applications

An embedded OAuth application is provided 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

The 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 app 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.

Create a Microsoft Entra ID App and a Microsoft Entra service principal

When authenticating using a Microsoft Entra service principal, you must create and register an Entra ID application with an Entra ID tenant. See Creating a Custom OAuth Application for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and 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.

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 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 Entra ID app.

Complete the Authentication

Choose whether to use a client secret or a certificate and follow the relevant steps below.

Client Secret

Set these connection properties:

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

Certificate

Set these connection properties:

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

You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Managed identities for Azure resources

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

Microsoft Entra service principal

If you would like to authenticate with a service principal instead of a client secret, it is also possible to authenticate with a client certificate. Set the following to authenticate:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AuthScheme: Set this to AzureServicePrincipal.
AzureTenant: Set this to the tenant you wish to connect to.
OAuthGrantType: Set this to CLIENT.
OAuthClientId: Set this to the Client ID 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.

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

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 you plan for your application to connect without a user context, select Application Permissions (OAuthGrantType = CLIENT). Otherwise, use the 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 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 Any Entra ID Directory - Multi Tenant. 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 your Azure Data Lake Storage account name.

Authenticate to Azure Data Lake Storage

You can authenticate to Azure Data Lake Storage via Access Key, Shared Access Signature (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 Data Lake 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 AzureAD in all user account flows.

Desktop Applications

An embedded OAuth application is provided 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

The 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 app 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.

Create a Microsoft Entra ID App and a Microsoft Entra service principal

When authenticating using a Microsoft Entra service principal, you must create and register an Entra ID application with an Entra ID tenant. See Creating a Custom OAuth Application for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and 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.

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 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 Entra ID app.

Complete the Authentication

Choose whether to use a client secret or a certificate and follow the relevant steps below.

Client Secret

Set these connection properties:

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

Certificate

Set these connection properties:

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

You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Managed identities for Azure resources

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

Microsoft Entra service principal

If you would like to authenticate with a service principal instead of a client secret, it is also possible to authenticate with a client certificate. Set the following to authenticate:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AuthScheme: Set this to AzureServicePrincipal.
AzureTenant: Set this to the tenant you wish to connect to.
OAuthGrantType: Set this to CLIENT.
OAuthClientId: Set this to the Client ID 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.

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

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 you plan for your application to connect without a user context, select Application Permissions (OAuthGrantType = CLIENT). Otherwise, use the 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 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 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

An embedded OAuth application is provided 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

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

An embedded OAuth application is provided 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

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

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, the Service account ID, and, optionally, a description.
Click DONE. The Cloud Console redisplays the Credentials page.
In the Service Accounts section, select the service account you just created.
Click the KEYS tab.
Click ADD KEY > Create new key.
Select any supported Key type (see OAuthJWTCert and OAuthJWTCertType).
Click CREATE. The key is automatically downloaded to your device, and any additional information specific to the key is displayed.
Record the additional information for future use.

To complete the service account flow, generate a private key in the Google Cloud Console. In the service account flow, the driver exchanges a JSON Web token (JWT) for the OAuthAccessToken. The private key is required to sign the JWT. The driver will have the same permissions granted to the service account.

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

An embedded OAuth application is provided 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

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, the Service account ID, and, optionally, a description.
Click DONE. The Cloud Console redisplays the Credentials page.
In the Service Accounts section, select the service account you just created.
Click the KEYS tab.
Click ADD KEY > Create new key.
Select any supported Key type (see OAuthJWTCert and OAuthJWTCertType).
Click CREATE. The key is automatically downloaded to your device, and any additional information specific to the key is displayed.
Record the additional information for future use.

To complete the service account flow, generate a private key in the Google Cloud Console. In the service account flow, the driver exchanges a JSON Web token (JWT) for the OAuthAccessToken. The private key is required to sign the JWT. The driver will have the same permissions granted to the service account.

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 HMAC or OAuth authentication.

HMAC

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 a Microsoft Entra ID user, with MSI authentication, or using a Microsoft Entra service principal.

Microsoft Entra ID Users

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

Desktop Applications

An embedded OAuth application is provided 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

The 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 app 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.

Create a Microsoft Entra ID App and a Microsoft Entra service principal

When authenticating using a Microsoft Entra service principal, you must create and register a Microsoft Entra ID application with a Microsoft Entra ID tenant. See Creating a Custom OAuth Application for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and 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.

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 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.

Complete the Authentication

Choose whether to use a client secret or a certificate and follow the relevant steps below.

Client Secret

Set these connection properties:

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

Certificate

Set these connection properties:

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

You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Managed identities for Azure resources

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

Microsoft Entra service principal

If you would like to authenticate with a service principal instead of a client secret, it is also possible to authenticate with a client certificate. Set the following to authenticate:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AuthScheme: Set this to AzureServicePrincipal.
AzureTenant: Set this to the tenant you wish to connect to.
OAuthGrantType: Set this to CLIENT.
OAuthClientId: Set this to the Client ID 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.

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

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 you plan for your application to connect without a user context, select Application Permissions (OAuthGrantType = CLIENT). Otherwise, use the 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 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 AzureAD in all user account flows.

Desktop Applications

An embedded OAuth application is provided 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

The 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 app 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.

Create a Microsoft Entra ID App and a Microsoft Entra service principal

When authenticating using a Microsoft Entra service principal, you must create and register a Microsoft Entra ID application with a Microsoft Entra ID tenant. See Creating a Custom OAuth Application for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and 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.

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 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.

Complete the Authentication

Choose whether to use a client secret or a certificate and follow the relevant steps below.

Client Secret

Set these connection properties:

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

Certificate

Set these connection properties:

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

You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Managed identities for Azure resources

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

Microsoft Entra service principal

If you would like to authenticate with a service principal instead of a client secret, it is also possible to authenticate with a client certificate. Set the following to authenticate:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AuthScheme: Set this to AzureServicePrincipal.
AzureTenant: Set this to the tenant you wish to connect to.
OAuthGrantType: Set this to CLIENT.
OAuthClientId: Set this to the Client ID 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.

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

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 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 (REST)

The following authentication schemes are supported for the REST API:

Microsoft Entra ID
MSI
AzureServicePrincipal

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 AzureAD. 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

An embedded OAuth application is provided 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

The 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 app 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.

Create a Microsoft Entra ID App and a Microsoft Entra service principal

When authenticating using a Microsoft Entra service principal, you must create and register a Microsoft Entra ID application with a Microsoft Entra ID tenant. See Creating a Custom OAuth Application for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and 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.

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 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.

Complete the Authentication

Choose whether to use a client secret or a certificate and follow the relevant steps below.

Client Secret

Set these connection properties:

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

Certificate

Set these connection properties:

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

You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

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:

AuthScheme: Set this to the AzureServicePrincipal in your app settings.
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.
OAuthGrantType: Set this to CLIENT.

Option 1: Authenticating using a Client Secret

Set the following to authenticate with a client secret:

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:

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 (SOAP)

The following authentications are supported for the SOAP API:

User Credentials
ADFS
Okta
OneLogin

User Credentials

ADFS

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

User: Set this to the ADFS user.
Password: Set this to 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;URL='http://sharepointserver/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 Okta password for the user.
SSOLoginURL: Set this to your Okta applications's embed link.

The following is an example connection string:

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/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.

The following is an example connection string:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';

Create a Custom Microsoft Entra ID App

When to Create a Custom OAuth App

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 you plan for your application to connect without a user context, select the Application Permissions (OAuthGrantType = CLIENT). Otherwise, when selecting permissions, use the 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 "OAuth: Admin Consent" in Establishing a Connection.

SSO connections

Authenticate with SSO

Service Provider	Okta	OneLogin	ADFS	AzureAD
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	Y	Y	Y
SharePoint Online REST
Wasabi
Google Cloud Storage
Oracle Cloud Storage
Azure File

Microsoft Entra ID

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 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 AzureAD.
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=AzureAD;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_AzureAD;AWSPrincipalARN=arn:aws:iam:215515180:saml-provider/AzureAD;

OneLogin

OneLogin Configuration

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

Sharepoint SOAP: 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 SOAP

The following properties must be specified when connecting to Sharepoint SOAP 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 be set this property if the domain configured on the SSO domain is different than the domain of the User.

The following is an example connection string:

AuthScheme='OneLogin';User=test;Password=test;SSOProperties='Domain=test.cdata;';

Okta

Okta Configuration

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

Sharepoint SOAP: 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 SOAP

The following properties must be specified when connecting to Sharepoint SOAP 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 be set this property if the domain configured on the SSO domain is different than the domain of the User.

The following is an example connection string:

AuthScheme='Okta';User=test;Password=test;SSOProperties='Domain=test.cdata;';

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 SOAP: 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 SOAP

The following properties must be specified when connecting to a Sharepoint SOAP 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 be set this property if the domain configured on the SSO domain is different than the domain of the User.

The following is an example connection string:

AuthScheme='ADFS';User=test;Password=test;SSOProperties='Domain=test.cdata;';

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 Cerberos 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 allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

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

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).

See Query Processing for more information.

User Defined Views

The Jitterbit Connector for Microsoft Excel allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used 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 as follows:

Each root element defines the name of a view.
Each root element contains 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

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting 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 SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

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.

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`	Creates a schema file for the resource.
`CreateWorksheet`	Creates a new worksheet in an Excel workbook. If the workbook does not exist, the workbook will also be created.
`GetOAuthAccessToken`	Obtains the OAuth access token to be used for authentication with storage sources using OAuth.
`GetOAuthAuthorizationURL`	Obtains the OAuth authorization URL used for authentication with storage sources using OAuth.
`RefreshOAuthAccessToken`	Exchanges a refresh token for a new access token.

CreateSchema

Creates a schema file for the resource.

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`	The name of the collection and also the name of the schema (.rsd) file.
`URI`	`String`	The Uniform Resource Identifier (URI) of the CSV resource.
`FileName`	`String`	The file name of the generated schema file (.rsd file). Use the Location connection property to specify the path to the schema file.

Result Set Columns

Name	Type	Description
`Result`	`String`	Returns Success or Failure.
`FileData`	`String`	If the FileName input is empty.

CreateWorksheet

Creates a new worksheet in an Excel workbook. If the workbook does not exist, the workbook will also be created.

Input

Name	Type	Description
`File`	`String`	The path to the Excel workbook.
`Sheet`	`String`	The name of the Excel worksheet to create inside the workbook. The default value is sheet1.
`Columnnames`	`String`	Comma-separated list of column names to add to the new spreadsheet. Column names cannot contain white space.

Result Set Columns

Name	Type	Description
`File`	`String`	The name of Excel workbook that has been updated.
`Sheet`	`String`	The name of the Excel worksheet created inside the workbook. May be different from the sheet specified if the name conflicts with an existing sheet.

GetOAuthAccessToken

Obtains the OAuth access token to be used for authentication with storage sources using OAuth.

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. The default value is CODE.
`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

Obtains the OAuth authorization URL used for authentication with storage sources using OAuth.

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.
`AuthSecret`	`String`	This field is deprecated. Please use AuthKey going forward.
`URL`	`String`	The URL to complete user authentication.

RefreshOAuthAccessToken

Exchanges a refresh token for a new access token.

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.

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.

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.

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

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.
`DataTypeName`	`String`	The name of the data type.
`DataType`	`Int32`	An integer indicating the data type. This value is determined at run time based on the environment.
`Length`	`Int32`	The number of characters allowed for character data. The number of digits allowed for numeric data.
`NumericPrecision`	`Int32`	The maximum precision for numeric data. The column length in characters for character and date-time 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.

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.

When querying this table, the config connection string should be used:

jdbc:cdata:excel:config:

This connection string enables you to query this table without a valid connection.

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.

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`	Your account access key. 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`	The Uniform Resource Identifier (URI) for the Excel resource location.
`DefineTables`	Map Excel ranges to table names.
`Header`	Indicates whether the first row should be used as a column header.
`Orientation`	Indicates whether the data in Excel is laid out horizontally or vertically.
`ExcelFile`	The location of an Excel file.
`BufferChanges`	Indicates whether to hold changes to the data in memory until the connection is closed.
`Region`	The hosting region for your S3-like Web Services.
`ProjectId`	The ID of the project where your Google Cloud Storage instance resides.
`OracleNamespace`	The Oracle Cloud Object Storage namespace to use.
`StorageBaseURL`	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.
`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`	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.
`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.
`TemporaryTokenDuration`	The amount of time (in seconds) a temporary token will last.

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`	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
`AzureEnvironment`	The Azure Environment to use when establishing a connection.

SSO

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

Data

Property	Description
`AllowFormula`	Whether or not to treat values starting with an equals (=) sign as formulas during INSERTs and updates.
`EmptyValueMode`	Indicates whether to read the empty values as empty or as null.
`NullValues`	A comma separated list which will be replaced with nulls if there are found in the CSV file.
`IgnoreCalcError`	Indicates whether to ignore errors that occurred during the calculation.
`NullValueMode`	Indicates whether to read empty cells as null or as empty.
`HasCrossSheetReferences`	Indicates how cross sheet references are handled.
`Recalculate`	Indicates whether to recalculate all formulas when data is read.
`ShowEmptyRows`	Indicates whether or not the empty rows should be pushed.
`TypeDetectionScheme`	Determines how the provider detects the data types of columns.
`EnableOleDbCompatibility`	Indicates whether to read the data with the same behavior as the Microsoft OleDB driver.
`UseFastInsert`	Indicates whether to use the fastInsert when executing INSERT Statement.
`AggregateFiles`	Allows URI to be set to a local directory instead of a single file. Aggregates the contents of all identically structured files in the directory to one table per sheet.
`SkipTop`	Skips the number of rows specified starting from the top.
`IncludeCustomNames`	Indicates whether or not the defined names should be pushed.
`IncludeSubdirectories`	Includes the subdirectories of the URI in the aggregation when AggregateFiles is set to true.
`MetadataDiscoveryURI`	Indicates which file is considered the metadata document when the AggregateFiles is set to true.
`UseSimpleNames`	Indicates whether to simplify returned column names. Any non-alphanumeric characters present in the column names will be converted to an underscore.

OAuth

Property	Description
`InitiateOAuth`	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
`OAuthVersion`	The version of OAuth being used.
`OAuthClientId`	The client ID assigned when you register your application with an OAuth authorization server.
`OAuthClientSecret`	The client secret assigned when you register your application with an OAuth authorization server.
`OAuthAccessToken`	The access token for connecting using OAuth.
`OAuthAccessTokenSecret`	The OAuth access token secret for connecting using OAuth.
`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://'`.
`CallbackURL`	The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
`Scope`	Specify scope to obtain the initial access and refresh token.
`OAuthGrantType`	The grant type for the OAuth flow.
`OAuthPasswordGrantMode`	How to pass Client ID and Secret with OAuthGrantType is set to Password.
`OAuthIncludeCallbackURL`	Whether to include the callback URL in an access token request.
`OAuthAuthorizationURL`	The authorization URL for the OAuth service.
`OAuthAccessTokenURL`	The URL to retrieve the OAuth access token from.
`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`	The verifier code returned from the OAuth authorization URL.
`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`	The OAuth refresh token for the corresponding OAuth access token.
`OAuthExpiresIn`	The lifetime in seconds of the OAuth AccessToken.
`OAuthTokenTimestamp`	The Unix epoch timestamp in milliseconds when the current Access Token was created.

JWT OAuth

Property	Description
`OAuthJWTCert`	The JWT Certificate store.
`OAuthJWTCertType`	The type of key store containing the JWT Certificate.
`OAuthJWTCertPassword`	The password for the OAuth JWT certificate.
`OAuthJWTCertSubject`	The subject of the OAuth JWT 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`	The Kerberos Key Distribution Center (KDC) service used to authenticate the user.
`KerberosRealm`	The Kerberos Realm used to authenticate the user.
`KerberosSPN`	The service principal name (SPN) for the Kerberos Domain Controller.
`KerberosKeytabFile`	The Keytab file containing your pairs of Kerberos principals and encrypted keys.
`KerberosServiceRealm`	The Kerberos realm of the service.
`KerberosServiceKDC`	The Kerberos KDC of the service.
`KerberosTicketCache`	The full file path to an MIT Kerberos credential cache file.

SSL

Property	Description
`SSLClientCert`	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
`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.
`SSLMode`	The authentication mechanism to be used when connecting to the FTP or FTPS server.
`SSLServerCert`	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.

Schema

Property	Description
`Location`	A path to the directory that contains the schema files defining tables, views, and stored procedures.
`BrowsableSchemas`	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
`Tables`	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
`Views`	Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property	Description
`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`	Other headers as determined by the user (optional).
`CustomUrlParams`	The custom query string to be included in the request.
`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.
`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`	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
`Other`	These hidden properties are used only in specific use cases.
`PseudoColumns`	This property indicates whether or not to include pseudo columns as columns to the table.
`RowScanDepth`	The maximum number of rows to scan to look for the columns available in a table.
`Timeout`	The value in seconds until the timeout error is thrown, canceling the operation.
`UserDefinedViews`	A filepath pointing to the JSON configuration file containing your custom views.

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`	Your account access key. 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

Basic, AwsRootKeys, OneLogin, AwsEC2Roles, None, SFTP, AwsIAMRoles, Negotiate, ADFS, OAuthJWT, Okta, GCPInstanceAccount, PingFederate, Digest, AwsMFA, OAuthPassword, AwsTempCredentials, OAuthClient, AwsCredentialsFile, OAuthPKCE, AzureAD, AzureMSI, AzureServicePrincipal, AzureServicePrincipalCert, AccessKey, AzureStorageSAS, HMAC, OAuth

Data Type

string

Default Value

""

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.
AwsMFA: Set to use multi factor authentication.
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.

Various 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 either OAuth1 or OAuth2, with the specific flow being determined by the OAuthGrantType. OAuthVersion must be set to determine what version of OAuth is used.
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 either OAuth1 or OAuth2, with the specific flow being determined by the OAuthGrantType. OAuthVersion must be set to determine what version of OAuth is used.

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 either OAuth1 or OAuth2, with the specific flow being determined by the OAuthGrantType. OAuthVersion must be set to determine what version of OAuth is used.
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, with the specific flow being determined by the OAuthGrantType. 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 either OAuth with the specific flow being determined by the InitiateOAuth. ApiKey must be set to successfully complete this flow.
HMAC: 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:

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

SFTP

This ConnectionType defaults to using an AuthScheme called SFTP, but the authentication method is actually controlled using the SSHAuthMode property. See this property's documentation for further information.

SharePoint REST

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

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 also available when ConnectionType is set to SharePoint SOAP:

Basic: Use basic user/password credentials to authenticate.
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.
OneLogin: Set to use a single sign on connection with OneLogin as the identify provider.

AccessKey

""

Remarks

The User and Password are together used to authenticate with the server.

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

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

Possible Values

SharePointOnline, SharePointOnPremise

Data Type

string

Default Value

SharePointOnline

Remarks

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`	The Uniform Resource Identifier (URI) for the Excel resource location.
`DefineTables`	Map Excel ranges to table names.
`Header`	Indicates whether the first row should be used as a column header.
`Orientation`	Indicates whether the data in Excel is laid out horizontally or vertically.
`ExcelFile`	The location of an Excel file.
`BufferChanges`	Indicates whether to hold changes to the data in memory until the connection is closed.
`Region`	The hosting region for your S3-like Web Services.
`ProjectId`	The ID of the project where your Google Cloud Storage instance resides.
`OracleNamespace`	The Oracle Cloud Object Storage namespace to use.
`StorageBaseURL`	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.
`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

Auto, Local, Amazon S3, Azure Blob Storage, Azure Data Lake Storage Gen1, 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 REST, SharePoint SOAP

Data Type

string

Default Value

Auto

Remarks

Set the ConnectionType to one of the following:

Auto: The connector infers the connection type from the syntax of the provided URI.
Local: Microsoft Excel files stored on your local machine.
Amazon S3
Azure Blob Storage
Azure Data Lake Storage Gen1
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 REST
SharePoint SOAP

URI

The Uniform Resource Identifier (URI) for the Excel resource location.

Data Type

string

Default Value

""

Remarks

Set the URI property to specify a path to a file or stream.

Below are examples of the URI formats for the available data sources:

Service Provider	URI Formats
Local	`localPath/file.xlsx` `file://localPath/file.xlsx`
HTTP or HTTPS	`http://remoteStream` `https://remoteStream`
Amazon S3	`s3://remotePath/file.xlsx`
Google Drive	`gdrive://remotePath/file.xlsx`
Box	`box://remotePath/file.xlsx`
FTP or FTPS	`ftp://server:port/remotePath/file.xlsx` `ftps://server:port/remotepath/file.xlsx`
SFTP	`sftp://server:port/remotePath/file.xlsx`
Sharepoint	`sp://https://server/remotePath/file.xlsx`

Example Connection Strings and Queries

Below are example connection strings to Excel files or streams.

Service Provider	URI Formats	Connection example	Query example (if file.xlsx contains sheet1 or streamname1 is a Excel stream)
Local	`localPath` `file://localPath/file.xlsx`	URI=C:/folder1/file.xlsx	SELECT * FROM sheet1
HTTP or HTTPS	`http://remoteStream` `https://remoteStream`	URI=http://www.host1.com/streamname1;	SELECT * FROM streamedtable
Amazon S3	`s3://bucket1/folder1/file.xlsx`	URI=s3://bucket1/folder1/file.xlsx; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO;	SELECT * FROM sheet1
Google Drive	`gdrive://remotePath/file.xlsx`	URI=gdrive://folder1/file.xlsx;InitiateOAuth=GETANDREFRESH;	SELECT * FROM sheet1
Box	`box://remotePath/file.xlsx`	URI=box://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;	SELECT * FROM sheet1
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;	SELECT * FROM sheet1
SFTP	`sftp://server:port/remotePath/file.xlsx`	URI=sftp://127.0.0.1:22/remotePath/file.xlsx; User=user1; Password=password1;	SELECT * FROM sheet1
Sharepoint	`sp://https://server/remotePath/file.xlsx`	URI=sp://https://domain.sharepoint.com/Documents/file.xlsx; User=user1; Password=password1;	SELECT * FROM sheet1

Vertical

Remarks

By default, the connector models vertically oriented spreadsheet data -- rows arranged vertically below a header row.

Set this to "Horizontal" if the rows are arranged left to right. The first column contains the column names and subsequent columns become rows.

The Header property is used in conjunction with the Orientation property. When Header is set to false and Orientation is set to Columns, column names are reported as R1, R2, R3, etc.

If you want to exclude any sheets from this rule you can set: Orientation=Horizontal, Sheet1=vertical (means orientation is set to horizontal for all sheets except Sheet1)

ExcelFile

The location of an Excel file.

Data Type

string

Default Value

""

Remarks

This property is deprecated and is replaced with URI.

A path that points to an Excel file. The file must exist. The connector implements support for Office Open XML spreadsheets used by Excel 2007 and later.

BufferChanges

Indicates whether to hold changes to the data in memory until the connection is closed.

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 sprest:// scheme.

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.

UseLakeFormation

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.

However, for MFA required connection, a new MFAToken must be specified in the connection to retrieve a new temporary token. This is a more intrusive issue since it requires an update to the connection by the user. The maximum and minimum that can be specified will depend largely on the connection being used.

For Role based authentication, the minimum duration is 900 seconds (15 minutes) while the maximum if 3600 (1 hour). Even if MFA is used with role based authentication, 3600 is still the maximum.

For MFA authentication by itself (using an IAM User or root user), the minimum is 900 seconds (15 minutes), the maximum is 129600 (36 hours).

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`	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
`AzureEnvironment`	The Azure Environment to use when establishing a connection.

AzureStorageAccount

The name of your Azure storage account.

Data Type

string

Default Value

""

Remarks

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.

AzureEnvironment

The Azure Environment to use when establishing a connection.

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

Data Type

string

Default Value

GLOBAL

Remarks

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, 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 in a semicolon-separated list.
`SSOExchangeUrl`	The URL used for consuming the SAML response and exchanging it for service specific credentials.

SSOLoginURL

The identity provider's login URL.

Data Type

string

Default Value

Remarks

HasCrossSheetReferences controls how cross sheet references are handled. If there are cross sheet references, changes to one sheet may cause some other formulas in other sheets to be recalculated. If HasCrossSheetReferences is set to true, all sheets in the workbook will be loaded into memory and the cross sheet references would be handled. However, setting the property to true may slow down performance because all sheets will be read from the Excel file.

When AggregateFiles is set to true, BufferChanges must be set to false.

A single file is used as the metadata document, which defines the expected structure that other files in the aggregation must follow.

You can explicitly set a file to be the metadata document with MetadataDiscoveryURI. If the MetadataDiscoveryURI is not set, the first file in the directory is used as the metadata document.

The connector assumes that all files in the directory have the same basic structure.

false

Remarks

Excel columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the provider easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed column names. Any non-alphanumeric characters will be converted to an underscore.

OAuth

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

Property	Description
`InitiateOAuth`	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
`OAuthVersion`	The version of OAuth being used.
`OAuthClientId`	The client ID assigned when you register your application with an OAuth authorization server.
`OAuthClientSecret`	The client secret assigned when you register your application with an OAuth authorization server.
`OAuthAccessToken`	The access token for connecting using OAuth.
`OAuthAccessTokenSecret`	The OAuth access token secret for connecting using OAuth.
`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://'`.
`CallbackURL`	The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
`Scope`	Specify scope to obtain the initial access and refresh token.
`OAuthGrantType`	The grant type for the OAuth flow.
`OAuthPasswordGrantMode`	How to pass Client ID and Secret with OAuthGrantType is set to Password.
`OAuthIncludeCallbackURL`	Whether to include the callback URL in an access token request.
`OAuthAuthorizationURL`	The authorization URL for the OAuth service.
`OAuthAccessTokenURL`	The URL to retrieve the OAuth access token from.
`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`	The verifier code returned from the OAuth authorization URL.
`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`	The OAuth refresh token for the corresponding OAuth access token.
`OAuthExpiresIn`	The lifetime in seconds of the OAuth AccessToken.
`OAuthTokenTimestamp`	The Unix epoch timestamp in milliseconds when the current Access Token was created.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthAccessTokenSecret

The OAuth access token secret for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

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\Acumatica 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\Acumatica 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

true

Remarks

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

JWT OAuth

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

Property	Description
`OAuthJWTCert`	The JWT Certificate store.
`OAuthJWTCertType`	The type of key store containing the JWT Certificate.
`OAuthJWTCertPassword`	The password for the OAuth JWT certificate.
`OAuthJWTCertSubject`	The subject of the OAuth JWT certificate.
`OAuthJWTIssuer`	The issuer of the Java Web Token.
`OAuthJWTSubject`	The user subject for which the application is requesting delegated access.

OAuthJWTCert

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject

field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

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.

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

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.

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`	The Kerberos Key Distribution Center (KDC) service used to authenticate the user.
`KerberosRealm`	The Kerberos Realm used to authenticate the user.
`KerberosSPN`	The service principal name (SPN) for the Kerberos Domain Controller.
`KerberosKeytabFile`	The Keytab file containing your pairs of Kerberos principals and encrypted keys.
`KerberosServiceRealm`	The Kerberos realm of the service.
`KerberosServiceKDC`	The Kerberos KDC of the service.
`KerberosTicketCache`	The full file path to an MIT Kerberos credential cache file.

KerberosKDC

The Kerberos Key Distribution Center (KDC) service used to authenticate the user.

Data Type

string

Default Value

""

Remarks

The Kerberos properties are used when using SPNEGO or Windows Authentication. The connector will request session tickets and temporary session keys from the Kerberos KDC service. The Kerberos KDC service is conventionally colocated with the domain controller.

If Kerberos KDC 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 KDC 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 configured domain name and host.

Note

Windows authentication is supported in JRE 1.6 and above only.

KerberosRealm

The Kerberos Realm used to authenticate the user.

Data Type

string

Default Value

""

Remarks

The Kerberos properties are used when using SPNEGO or Windows Authentication. The Kerberos Realm is used to authenticate the user with the Kerberos Key Distribution Service (KDC). The Kerberos Realm can be configured by an administrator to be any string, but conventionally it is 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.

Note

SSLClientCert

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

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.

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 (for example, PKCS12 certificate store).

SSLClientCertType

The type of key store containing the TLS/SSL client 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

Data Type

string

Default Value

USER

Remarks

This property can take one of the following values:

Property	Description
`USER - default`	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
`MACHINE`	For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
`PFXFILE`	The certificate store is the name of a PFX (PKCS12) file containing certificates.
`PFXBLOB`	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
`JKSFILE`	The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
`JKSBLOB`	The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
`PEMKEY_FILE`	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
`PEMKEY_BLOB`	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
`PUBLIC_KEY_FILE`	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
`PUBLIC_KEY_BLOB`	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
`SSHPUBLIC_KEY_FILE`	The certificate store is the name of a file that contains an SSH-style public key.
`SSHPUBLIC_KEY_BLOB`	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
`P7BFILE`	The certificate store is the name of a PKCS7 file containing certificates.
`PPKFILE`	The certificate store is the name of a file that contains a PuTTY Private Key (PPK).
`XMLFILE`	The certificate store is the name of a file that contains a certificate in XML format.
`XMLBLOB`	The certificate store is a string that contains a certificate in XML format.

SSLClientCertPassword

The password for the TLS/SSL client certificate.

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

SSLClientCertSubject

The subject of the TLS/SSL client certificate.

Data Type

string

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 example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown 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.

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

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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`

If not specified, any certificate trusted by the machine is accepted.

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).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

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. Newlines may be replaced with spaces when providing the blob as 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.

Schema

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

Property	Description
`Location`	A path to the directory that contains the schema files defining tables, views, and stored procedures.
`BrowsableSchemas`	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
`Tables`	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
`Views`	Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\Excel Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to 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" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
`Windows`	The value of the APPDATA environment variable
`Mac`	~/Library/Application Support
`Linux`	~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

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

Property	Description
`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`	Other headers as determined by the user (optional).
`CustomUrlParams`	The custom query string to be included in the request.
`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.
`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`	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
`Other`	These hidden properties are used only in specific use cases.
`PseudoColumns`	This property indicates whether or not to include pseudo columns as columns to the table.
`RowScanDepth`	The maximum number of rows to scan to look for the columns available in a table.
`Timeout`	The value in seconds until the timeout error is thrown, canceling the operation.
`UserDefinedViews`	A filepath pointing to the JSON configuration file containing your custom views.

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties, like ContentType, From, and so on.

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

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

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`	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
`RecordToFile=filename`	Records the underlying socket data transfer to the specified file.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

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 as follows:

Each root element defines the name of a view.
Each root element contains 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

Note that the specified path is not embedded in quotation marks.