Microsoft Excel Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 21.0.8662 of the connector.

Get Started¶

Excel Version Support

The connector supports the Office Open XML spreadsheets used by Excel 2007 and later.

View Remote Excel Metadata¶

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

This streamed file content does not include all of the metadata associated with remotely stored 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 Excel must be used in tandem with the associated file system driver(s) for the service the 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 Excel file metadata.

Establish a Connection¶

Connect to Excel Data Sources¶

The Jitterbit Connector for 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 Files¶

While the connector is capable of pulling data from 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 CSV file stored on SharePoint, you could use the SharePoint connector's DownloadDocument procedure to download the CSV file, update the local CSV file with the CSV connector, then use the SharePoint connector's UploadDocument procedure to upload the changed file to SharePoint.

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¶

Set the URI to an Excel file in a bucket. Additionally, set the following properties to authenticate:

• AWSAccessKey: Set this to an Amazon Web Services Access Key (a username).
• AWSSecretKey: Set this to an Amazon Web Services Secret Key.

For example:

URI=s3://bucket1/folder1/file.xlsx; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO;

Optionally, specify AWSRegion in addition.

For example, if the StorageBaseURL conn prp is set to http://s3.%region%.myservice.com and Region is region-1, then we will generate request URLs like https://s3.region-1.myservice.com/bucket/... (or like https://bucket.s3.region-1.myservice.com/..., if the UseVirtualHosting property is true).

Connect to Oracle Cloud Object Storage¶

Set the URI to an Excel file in a bucket. Additionally, set the following properties to authenticate:

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

For example:

URI=os://bucket/remotePath/; AccessKey=token1; SecretKey=secret1; OracleNamespace=myNamespace; Region=us-ashburn-1;

Optionally, specify Region in addition.

Connect to Wasabi¶

Set the URI to an Excel file in a bucket. Additionally, set the following properties to authenticate:

• AccessKey: Set this to a Wasabi Access Key (a username)
• SecretKey: Set this to a Wasabi Secret Key.

Optionally, specify Region in addition.

For example:

URI=wasabi://bucket1/folder1/file.xlsx; AccessKey=token1; SecretKey=secret1; Region=OHIO;

Connect to Azure Blob Storage¶

Set the URI to the name of your container and the name of the blob. Additionally, set the following properties to authenticate:

• AzureStorageAccount: Set this to the account associated with the Azure blob.
• AzureAccessKey: Set this to the access key associated with the Azure blob.

For example:

URI=azureblob://mycontainer/myblob/; AzureStorageAccount=myAccount; AzureAccessKey=myKey;

You can also use the OAuth authentication to connect with Azure Blob Storage. For example:

URI=azureblob://mycontainer/myblob/; AzureStorageAccount=myAccount; AuthScheme=AzureAD; InitiateOAuth=GETANDREFRESH;

If you are connecting from an Azure VM with permissions for Azure Blob storage, you can simply use the AzureMSI AuthScheme For example:

URI=azureblob://mycontainer/myblob/; AzureStorageAccount=myAccount; AuthScheme=AzureMSI;

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.

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

For example:

AuthScheme=AzureServicePrincipal;InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;;AzureTenant=MyAzureTenant;OAuthJWTCert=MyOAuthJWTCert;OAuthJWTCertType=PFXFile

Connect to Azure Data Lake Store Gen 2¶

Set the URI to the name of the file system, the name of the folder which contacts your Excel files, and the name of an Excel file. Additionally, set the following properties to authenticate:

• AzureStorageAccount: Set this to the account associated with the Azure data lake store.
• AzureAccessKey: Set this to the access key associated with the Azure data lake store.

For example:

URI=abfs://myfilesystem/folder1/file.xlsx; AzureStorageAccount=myAccount; AzureAccessKey=myKey;
URI=abfss://myfilesystem/folder1/file.xlsx; AzureStorageAccount=myAccount; AzureAccessKey=myKey;

You can also use the OAuth authentication to Connect with Azure Data Lake Store Gen 2. For example:

URI=abfss://myfilesystem/folder1; AzureStorageAccount=myAccount; AuthScheme=AzureAD; InitiateOAuth=GETANDREFRESH;

If you are connecting from an Azure VM with permissions to connect to Azure Data Lake Store Gen 2, you can simply set AuthScheme to AzureMSI. For example:

URI=abfss://myfilesystem/folder1; AzureStorageAccount=myAccount; AuthScheme=AzureMSI;

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.

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

For example:

AuthScheme=AzureServicePrincipal;InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;;AzureTenant=MyAzureTenant;OAuthJWTCert=MyOAuthJWTCert;OAuthJWTCertType=PFXFile

Connect to Azure File Storage¶

Set the URI to the name of your azure file share and the name of the resource. Additionally, set the following properties to authenticate:

• AzureStorageAccount (Required): Set this to the account associated with the Azure file.
• 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.

For example:

URI=azurefile://fileShare/remotePath/file.xlsx; AzureStorageAccount=myAccount; AzureAccessKey=myAccessKey;

URI=azurefile://fileShare/remotePath/file.xlsx; AzureStorageAccount=myAccount; AzureSharedAccessSignature=mySharedSignature;

Connect to Box¶

Set the URI to the path to a Excel file. To authenticate to Box, use the OAuth authentication standard. See Connecting to Box for an authentication guide.

For example:

URI=box://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;

Connect to Dropbox¶

Set the URI to the path to a Excel file. To authenticate to Dropbox, use the OAuth authentication standard. See Connecting to Dropbox for an authentication guide. You can authenticate with a user account or a service account. In the user account flow, you do not need to set any connection properties for your user credentials, as shown in the connection string below:

URI=dropbox://folder1/file.xlsx; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;

Connect to Google Drive¶

Set the URI to the path to the name of the file system, the name of the folder which contacts your Excel files, and the name of an Excel file. To access shared files, set SharedWithMe as the name of the folder which contains your Excel files. For example URI=gdrive://SharedWithMe/remotePath. To authenticate to Google APIs, use the OAuth authentication standard.

You can authorize the connector to connect to Google APIs on behalf of individual users or on behalf of a domain. See Connecting to Google Drive for a guide.

For example:

URI=gdrive://folder1/file.xlsx;InitiateOAuth=GETANDREFRESH;

Connect to IBM Object Storage Source¶

Set the URI to an Excel file in a bucket. Additionally, 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:

URI=ibmobjectstorage://bucket1/folder1; AccessKey=token1; SecretKey=secret1; Region=eu-gb;

Optionally, specify Region in addition.

You can also authenticate to your IBM Object Storage instance using OAuth AuthScheme:

• AuthScheme: Set this to OAuth.
• ApiKey: Set this to your IBM API Key.
• Region: Set this property to your IBM instance region.

For example:

URI=ibmobjectstorage://bucket1/folder1; ApiKey=key1; Region=eu-gb; AuthScheme=OAuth; InitiateOAuth=GETANDREFRESH;

Connect to HDFS¶

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.

Connect to SharePoint Online SOAP¶

Set the URI to a document library containing Excel files. To authenticate, set User and Password and StorageBaseURL.

For example:

URI=sp://Documents/folder1; User=user1; Password=password1; StorageBaseURL=https://subdomain.sharepoint.com;

Note that this connection method may not work if the StorageBaseURL ends with "-my.sharepoint.com". You should use the onedrive:// scheme when connecting to these sites because they do not support the components that of SharePoint that the connector needs to download files.

Connect to SharePoint Online REST¶

Set the URI to a document library containing Excel files. StorageBaseURL is optional. If not provided, the driver will work with the root drive. To authenticate, use the OAuth authentication standard.

For example:

URI=sp://Documents/folder1; InitiateOAuth=GETANDREFRESH; StorageBaseURL=https://subdomain.sharepoint.com;

Note that this connection method may not work if the StorageBaseURL ends with "-my.sharepoint.com". You should use the onedrive:// scheme when connecting to these sites because they do not support the components that of SharePoint that the connector needs to download files.

Connect to FTP¶

Set the URI to the address of the server followed by the path to the Excel file. To authenticate, set User and Password.

For example:

URI=ftps://localhost:990/folder1/file.xlsx; User=user1; Password=password1;

Connect to Google Cloud Storage¶

Set the URI to the path to the name of the file system, the name of the folder which contains your Excel files, and the name of a Excel file. To authenticate to Google APIs, provide a ProjectId.

For example:

URI=gs://bucket/remotePath/; ProjectId=PROJECT_ID;

Connect to Google Drive¶

The connector facilitates the following OAuth authentication flows:

• The user consent flow enables individual users to connect to their own data.
• The service account flow enables access to domain-wide data.

Use a User Account to Connect to Google¶

This OAuth flow requires the authenticating user to interact with Google using the browser. The connector facilitates this in various ways as described below.

Authenticate to Google¶

After setting InitiateOAuth to GETANDREFRESH, you are ready to connect. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property. 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:

1. Extracts the access token from the callback URL and authenticates requests.
2. Refreshes the access token when it expires.
3. Saves OAuth values to be persisted across connections. This file can be configured in OAuthSettingsLocation.

Use a Service Account to Connect to Domain-Wide Data¶

You can use a service account in this 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 complete the service account flow, generate a private key in the Google APIs Console. In the service account flow, the connector exchanges a JSON Web token (JWT) for the OAuthAccessToken. The private key is required to sign the JWT. The OAuthAccessToken authenticates that the connector has the same permissions granted to the service account.

Generate a Private Key¶

Follow the steps below to generate a private key and obtain the credentials for your application:

1. Log into the Google API Console.
2. Click Create Project or select an existing project.
3. In the API Manager, click Credentials -> Create Credentials -> Service Account Key. In the Service Account menu, select New Service Account or select an existing service account. In the Key Type section, select the P12 key type.
4. Click Create to download the key pair. The private key's password is displayed: Set this in OAuthJWTCertPassword.
5. In the Service Account Keys section on the Credentials page, click Manage Service Accounts and set OAuthJWTIssuer to the email address displayed in service account Id.
6. Click Library -> Google Drive API -> Enable API.
7. If using Domain Wide Delegation, you'll need to add the following scopes to the service account client ID in the Google Admin console. In the Admin Console, go to Security -> API controls -> Domain wide delegation -> Manage Domain Wide Delegation. Add the service account's ID and enter the following scopes: https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/devstorage.read_write

Authenticate with a Service Account¶

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 connection property.
• OAuthJWTCertType: Set this to "PFXFILE".
• OAuthJWTCertPassword: Set this to the password of the .p12 file.
• OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
• OAuthJWTIssuer: Set this to the email address of the service account.
• OAuthJWTCert: Set this to the path to the .p12 file.
• OAuthJWTSubject: Set this to the email address of the user for whom the application is requesting delegate access.

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

1. Creates and signs the JWT with the claim set required by the connector.
2. Exchanges the JWT for the access token.
3. Submits the JWT for a new access token when the token expires.

Connect to Box¶

Use the OAuth authentication standard to connect to Excel. You can connect with your user account or you can use a service account. The connector facilitates these OAuth flows as described below.

Authenticate with a User Account¶

The user account flow requires the authenticating user to interact with Excel via the browser.

You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect. 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.

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Note: The connector is already registered with Excel as an OAuth application and will automatically use its embedded OAuth credentials to connect.

Authenticate with a Service Account¶

Service accounts have silent authentication, without user authentication in the browser. You need to create an OAuth application in this flow. You can then connect to Excel data that the service account has permission to access.

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

• InitiateOAuth: Set this to GETANDREFRESH.
• OAuthClientId: Set this to the Client ID in your app settings.
• OAuthClientSecret: Set this to the Client Secret in your app settings.
• OAuthJWTCertType: Set this to "PEMKEY_FILE".
• OAuthJWTCert: Set this to the path to the .pem file you generated.
• OAuthJWTCertPassword: Set this to the password of the .pem file.
• OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
• OAuthJWTSubjectType: Set this to "enterprise" or "user" depending on the type of token you want to request. You also need to set the Application Access value in your app settings to the corresponding subject type. The default value of this connection property is "enterprise".
• OAuthJWTSubject: Set this 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 this to the ID of your public key in your app settings.

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

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

Connect to Dropbox¶

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

You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect. 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.

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Note: The connector is already registered with Excel as an OAuth application and will automatically use its embedded OAuth credentials to connect. If you want to use your own custom OAuth app, see Creating a Custom OAuth App.

SSO connections¶

Authenticate with SSO¶

AzureAD¶

Azure AD Configuration

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

1. 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 Azure AD.

     Save the step "Assign the Azure AD test user" until after provisioning so that you can select the AWS roles when assigning the user.

2. A "connector" application with user_impersonation permission on the SSO application you created in the previous step.

   Go to Azure Active Directory --> 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 Azure Active Directory 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 Azure AD 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. Azure AD 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 proccess 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 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 proccess 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 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 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 proccess 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 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 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 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¶

This section shows how to use the connector to authenticate to Excel using Kerberos.

Authenticate with Kerberos¶

To authenticate to Excel using Kerberos, set the following properties:

• AuthScheme: Set this to NEGOTIATE.
• KerberosKDC: Set this to the host name or IP Address of your Kerberos KDC machine.
• KerberosRealm: Set this to the realm of the Excel Kerberos principal. This will be the value after the '@' symbol (for instance, EXAMPLE.COM) of the principal value (for instance, ServiceName/MyHost@EXAMPLE.COM).
• KerberosSPN: Set this to the service and host of the Excel Kerberos Principal. This will be the value prior to the '@' symbol (for instance, ServiceName/MyHost) of the principal value (for instance, ServiceName/MyHost@EXAMPLE.COM).

Retrieve the Kerberos Ticket¶

You can use one of the following options to retrieve the required Kerberos ticket.

MIT Kerberos Credential Cache File¶

This option enables you to use the MIT Kerberos Ticket Manager or kinit command to get tickets. Note that you won't need to set the User or Password connection properties with this option.

1. Ensure that you have an environment variable created called KRB5CCNAME.
2. Set the KRB5CCNAME environment variable to a path pointing to your credential cache file (for instance, C:\krb_cache\krb5cc_0 or /tmp/krb5cc_0). This file will be created when generating your ticket with MIT Kerberos Ticket Manager.
3. To obtain a ticket, open the MIT Kerberos Ticket Manager application, click Get Ticket, enter your principal name and password, then click OK. If successful, ticket information will appear in Kerberos Ticket Manager and will now be stored in the credential cache file.
4. Now that the credential cache file has been created, the connector will use the cache file to obtain the kerberos ticket to connect to Excel.

As an alternative to setting the KRB5CCNAME environment variable, you can directly set the file path using the KerberosTicketCache property. When set, the connector will use the specified cache file to obtain the kerberos ticket to connect to Excel.

Keytab File¶

If the KRB5CCNAME environment variable has not been set, you can retrieve a Kerberos ticket using a Keytab File. To do this, 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 both the KRB5CCNAME environment variable and the _KerberosKeytabFile_ property have not been set, you can retrieve a ticket using a User and Password combination. To do this, set the User and Password properties to the user/password combo that you use to authenticate with Excel.

Cross-Realm Authentication¶

More complex Kerberos environments may require cross-realm authentication where multiple realms and KDC servers are used (e.g. where one realm/KDC is used for user authentication and another realm/KDC used for obtaining the service ticket).

In such an environment, the KerberosRealm and KerberosKDC properties can be set to the values required for user authentication. The KerberosServiceRealm and KerberosServiceKDC properties can be set 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 Harmony 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 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 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 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.

User Defined Views¶

The Jitterbit Connector for 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"

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 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 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 available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.

Jitterbit Connector for Excel Stored Procedures¶

CreateWorksheet¶

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

Input¶

Result Set Columns¶

GetOAuthAccessToken¶

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

Input¶

Result Set Columns¶

GetOAuthAuthorizationURL¶

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

Input¶

Result Set Columns¶

RefreshOAuthAccessToken¶

Exchanges a refresh token for a new access token.

Input¶

Result Set Columns¶

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

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

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¶

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

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¶

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¶

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¶

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¶

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¶

sys_sqlinfo¶

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

Collaborative Query Processing¶

When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.

Discovering the Data Source's SELECT Capabilities¶

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

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¶

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¶

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

Connection

AWS Authentication

Azure Authentication

SSO

Data

OAuth

JWT OAuth

Kerberos

SSL

SSH

Schema

Miscellaneous

Authentication¶

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

AuthScheme¶

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

Possible Values¶

None, Basic, Auto, Digest, NTLM, Negotiate, OAuth, OAuthJWT, SFTP, FTP, SSLCertificate, AwsRootKeys, AwsIAMRoles, AwsEC2Roles, AwsMFA, AwsTempCredentials, AwsCredentialsFile, AzureAD, AzureServicePrincipal, AzureMSI, OKTA, ADFS, OneLogin, PingFederate, HMAC

Data Type¶

string

Default Value¶

None

Remarks¶

General¶

The following options are generally available to all connections:

• None: Uses no authentication.
• Basic: Uses Basic authentication with User and Password.
• Auto: Determines the right type of authentication to use based on the service. Local files and HTTP will use None.

HTTP¶

The following options are available when URI refers to a web service:

• Digest: Uses HTTP Digest authentication with User and Password.
• NTLM: Uses NTLM authentication with User and Password set to your Windows credentials.
• Negotiate: Negotiates with the server to determine an authentication scheme. Typically used with Kerberos, which requires KerberosKDC, KerberosRealm and KerberosSPN.
• 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.
• SSL: Uses SSL client certificates to authenticate. Requires that URI be set to an HTTPS URL and that SSLClientCert and SSLClientCertType be set.

AWS¶

The following options are also available when URI points to an Amazon service:

• 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.
• AwsIAMRoles: Set to use IAM Roles for the connection.
• AwsEC2Roles: Set this to automatically use IAM Roles assigned to the EC2 machine the Jitterbit Connector for Excel is currently running on.
• AwsMFA: Set to use multi factor authentication.
• OKTA: Set to use a single sign on connection with OKTA as the identify provider.
• ADFS: Set to use a single sign on connection with ADFS as the identify provider.
• AzureAD: Set to use a single sign on connection with AzureAD as the identify provider.
• AwsTempCredentials: Set this to leverage temporary security credentials alongside a session token to connect.
• AwsCredentialsFile: Set to use a credential file for authentication.

Azure¶

The following options are also available when URI points to an Azure service:

• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.

SharePoint¶

The following options are also available when URI points to a SharePoint SOAP service:

• OKTA: Set to use a single sign on connection with OKTA as the identify provider.
• ADFS: Set to use a single sign on connection with ADFS as the identify provider.
• OneLogin: Set to use a single sign on connection with OneLogin as the identify provider.
• PingFederate: Set to use a single sign on connection with PingFederate as the identify provider.

IBM Cloud Object Storage¶

The following options are also available when URI points to a IBM Cloud Object Storage service:

• 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 the IBM Cloud Object Storage service.

User¶

The Excel user account used to authenticate.

Data Type¶

string

Default Value¶

""

Remarks¶

Together with Password, this field is used to authenticate against the Excel server.

Password¶

The password used to authenticate the user.

Data Type¶

string

Default Value¶

""

Remarks¶

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

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.

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:

Example Connection Strings and Queries¶

Below are example connection strings to Excel files or streams.

DefineTables¶

Map Excel ranges to table names.

Data Type¶

string

Default Value¶

""

Remarks¶

You can use this property to explicitly define ranges within an Excel Spreadsheet that will appear as tables; the connector automatically detects tables for spreadsheets and named ranges.

Mapping Table Names to Ranges¶

The DefineTables value is a comma-separated list of name-value pairs in the form [Table Name]=[Sheet Name]![Range]. Table Name is the name of the table you want to use for the data and will be used when issuing queries. Sheet Name is the name of the sheet within the Excel Spreadsheet and Range is the range of cells that contain the data for the table.

Here is an example DefineTables value: DefineTables="Table1=Sheet1!A1:N25,Table2=Sheet2!C3:M53"

Header¶

Indicates whether the first row should be used as a column header.

Data Type¶

string

Default Value¶

true

Remarks¶

If true, the first row will be used as a column header. Otherwise, the pseudo column names A, B, C, etc. will be used.

If you want to exclude any sheets from this rule you can set: Header=True, Sheet1= False (means headers are true for all sheets except Sheet1)

Orientation¶

Indicates whether the data in Excel is laid out horizontally or vertically.

Possible Values¶

Horizontal, Vertical

Data Type¶

string

Default Value¶

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.

Data Type¶

bool

Default Value¶

true

Remarks¶

Indicates whether to hold changes to the data in memory until the connection is closed. Setting this to false will write the changes immediately but there will be a performance hit when issuing lots of requests as the file must be opened and closed repeatedly.

Region¶

The hosting region for your S3-like Web Services.

Data Type¶

string

Default Value¶

""

Remarks¶

The hosting region for your S3-like Web Services.

Oracle Cloud Object Storage Regions¶

Wasabi Regions¶

ProjectId¶

The ID of the project where your Google Cloud Storage instance resides.

Data Type¶

string

Default Value¶

""

Remarks¶

The ID of the project where your Google Cloud Storage instance resides. You can find this value by going to Google Cloud Console and clicking the project name at the top left screen. The ProjectId is displayed on the ID column of the matching project.

OracleNamespace¶

The Oracle Cloud Object Storage namespace to use.

Data Type¶

string

Default Value¶

""

Remarks¶

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

StorageBaseURL¶

The URL of a cloud storage service provider.

Data Type¶

string

Default Value¶

""

Remarks¶

This connection property is used to specify:

• The URL of a custom S3 service

• The URL required for the Sharepoint SOAP/REST cloud storage service provider.

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

AWS Authentication¶

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

AWSAccessKey¶

Your AWS account access key. This value is accessible from your AWS security credentials page.

Data Type¶

string

Default Value¶

""

Remarks¶

Your AWS account access key. This value is accessible from your AWS security credentials page:

1. Sign into the AWS Management console with the credentials for your root account.
2. Select your account name or number and select My Security Credentials in the menu that is displayed.
3. Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.

AWSSecretKey¶

Your AWS account secret key. This value is accessible from your AWS security credentials page.

Data Type¶

string

Default Value¶

""

Remarks¶

Your AWS account secret key. This value is accessible from your AWS security credentials page:

1. Sign into the AWS Management console with the credentials for your root account.
2. Select your account name or number and select My Security Credentials in the menu that is displayed.
3. Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.

AWSRoleARN¶

The Amazon Resource Name of the role to use when authenticating.

Data Type¶

string

Default Value¶

""

Remarks¶

When authenticating outside of AWS, it is common to use a Role for authentication instead of your direct AWS account credentials. Entering the AWSRoleARN will cause the Jitterbit Connector for Excel to perform a role based authentication instead of using the AWSAccessKey and AWSSecretKey directly. The AWSAccessKey and AWSSecretKey must still be specified to perform this authentication. You cannot use the credentials of an AWS root user when setting RoleARN. The AWSAccessKey and AWSSecretKey must be those of an IAM user.

AWSPrincipalARN¶

The ARN of the SAML Identity provider in your AWS account.

Data Type¶

string

Default Value¶

""

Remarks¶

The ARN of the SAML Identity provider in your AWS account.

AWSRegion¶

The hosting region for your Amazon Web Services.

Possible Values¶

OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, STOCKHOLM, BAHRAIN, SAOPAULO, GOVCLOUDEAST, GOVCLOUDWEST

Data Type¶

string

Default Value¶

NORTHERNVIRGINIA

Remarks¶

The hosting region for your Amazon Web Services. Available values are OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, STOCKHOLM, BAHRAIN, SAOPAULO, GOVCLOUDEAST, and GOVCLOUDWEST.

AWSSessionToken¶

Your AWS session token.

Data Type¶

string

Default Value¶

""

Remarks¶

Your AWS session token. This value can be retrieved in different ways. See this link for more info.

MFASerialNumber¶

The serial number of the MFA device if one is being used.

Data Type¶

string

Default Value¶

""

Remarks¶

You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials. For virtual devices, this is actually an Amazon Resource Name (such as arn:aws:iam:123456789012:mfa/user).

MFAToken¶

The temporary token available from your MFA device.

Data Type¶

string

Default Value¶

""

Remarks¶

If MFA is required, this value will be used along with the MFASerialNumber to retrieve temporary credentials to login. The temporary credentials available from AWS will only last up to 1 hour by default (see TemporaryTokenDuration). Once the time is up, the connection must be updated to specify a new MFA token so that new credentials may be obtained. %AWSpSecurityToken; %AWSpTemporaryTokenDuration;

Azure Authentication¶

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

AzureStorageAccount¶

The name of your Azure storage account.

Data Type¶

string

Default Value¶

""

Remarks¶

The name of your Azure storage account.

AzureAccessKey¶

The storage key associated with your Excel account.

Data Type¶

string

Default Value¶

""

Remarks¶

The storage key associated with your Excel account. You can retrieve it as follows:

1. Sign into the azure portal with the credentials for your root account. (https://portal.azure.com/)
2. Click on storage accounts and select the storage account you want to use.
3. Under settings, click Access keys.
4. Your storage account name and key will be displayed on that page.

AzureSharedAccessSignature¶

A shared access key signature that may be used for authentication.

Data Type¶

string

Default Value¶

""

Remarks¶

A shared access signature. You can create one by following these steps:

1. Sign into the azure portal with the credentials for your root account. (https://portal.azure.com/)
2. Click on storage accounts and select the storage account you want to use.
3. Under settings, click Shared Access Signature.
4. Set the permissions and when the token will expire
5. Click Generate SAS can copy the token.

AzureTenant¶

The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.

Data Type¶

string

Default Value¶

""

Remarks¶

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory ID in the Azure Portal > Azure Active Directory > Properties.

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, GERMANY, 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, GERMANY, USGOVT, and USGOVTDOD.

SSO¶

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

SSOLoginURL¶

The identity provider's login URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The identity provider's login URL.

SSOProperties¶

Additional properties required to connect to the identity provider in a semicolon-separated list.

Data Type¶

string

Default Value¶

""

Remarks¶

Additional properties required to connect to the identity provider in a semicolon-separated list. is used in conjunction with the SSOLoginURL.

SSO configuration is discussed further in .

Data¶

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

AllowFormula¶

Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates.

Data Type¶

bool

Default Value¶

true

Remarks¶

Set this value to true to treat values beginning with an equals (=) sign as formulas on inserts and updates. Set the value to false to treat all values used in inserts and updates as strings.

EmptyValueMode¶

Indicates whether to read the empty values as empty or as null.

Possible Values¶

ReadAsEmpty, ReadAsNull

Data Type¶

string

Default Value¶

ReadAsEmpty

Remarks¶

Possible values are ReadAsEmpty and ReadAsNull. An empty value is a cell which contains an empty string (e.g., =""), which is different from a cell that has not been set and thus contains a null string.

NullValues¶

A comma separated list which will be replaced with nulls if there are found in the CSV file.

Data Type¶

string

Default Value¶

""

Remarks¶

A comma separated list which will be replaced with nulls if there are found in the CSV file. Example: "NaN,\N,N/A". If any of the specified values is found in a CSV row, it will be pushed as null.

IgnoreCalcError¶

Indicates whether to ignore errors that occurred during the calculation.

Data Type¶

bool

Default Value¶

false

Remarks¶

IgnoreCalcError defaults to false. If IgnoreCalcError is set to true, the provider will ignore any errors that occur due to formula calculation. If this happens, the formula result may be unreliable, but other data will be accurate.

NullValueMode¶

Indicates whether to read empty cells as null or as empty.

Possible Values¶

ReadAsNull, ReadAsEmpty

Data Type¶

string

Default Value¶

ReadAsNull

Remarks¶

NullValueMode controls how empty Excel cells are modelled. An empty cell is a cell that has not been set and thus contains a null string. If NullValueMode is set to ReadAsNull, NULL is reported for an empty cell; if NullValueMode is set to ReadAsEmpty, an empty string is reported for an empty cell.

HasCrossSheetReferences¶

Indicates how cross sheet references are handled.

Data Type¶

bool

Default Value¶

false

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.

This value should be set to true if you plan on making updates to the sheet. When this option is disabled the connector generates larger files because it cannot reuse shared data across multiple sheets. However, disabling this option allows the connector to reuse data across multiple sheets and generate smaller files.

Recalculate¶

Indicates whether to recalculate all formulas when data is read.

Data Type¶

bool

Default Value¶

true

Remarks¶

When cells in an Excel sheet are modified, the formula cells change their value. If Recalculate is set to true, the provider will detect changed cells and recalculate the formulas. These new results are then updated back to the Excel sheet so that a recalculation is not necessary.

ShowEmptyRows¶

Indicates whether or not the empty rows should be pushed.

Data Type¶

bool

Default Value¶

false

Remarks¶

If true, the empty rows will be pushed at the output.

TypeDetectionScheme¶

Determines how the provider detects the data types of columns.

Possible Values¶

None, RowScan, ColumnFormat, ColumnStyle

Data Type¶

string

Default Value¶

ColumnFormat

Remarks¶

EnableOleDbCompatibility¶

Indicates whether to read the data with the same behavior as the Microsoft OleDB driver.

Data Type¶

bool

Default Value¶

false

Remarks¶

Indicates whether to read the data with the same behavior as the Microsoft OleDB driver.For example, the Microsoft OleDB driver would report the the newline as '\n' instead of '\r\n'.

UseFastInsert¶

Indicates whether to use the fastInsert when executing Insert Statement.

Data Type¶

bool

Default Value¶

false

Remarks¶

The FastInsert has better performance than the common insert.However, the FastInsert didn't support the Insert statement with the specified ROWID and would save the insert data into the file after executing Insert Statement.

SkipTop¶

Skips the number of rows specified starting from the top.

Data Type¶

int

Default Value¶

0

Remarks¶

Skips the number of rows specified starting from the top.

IncludeCustomerNames¶

Indicates whether or not the defined names should be pushed.

Data Type¶

bool

Default Value¶

true

Remarks¶

If true, the defined names will be pushed.

OAuth¶

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

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:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. 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.
3. 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.

OAuthVersion¶

The version of OAuth being used.

Possible Values¶

Disabled, 1.0, 2.0

Data Type¶

string

Default Value¶

Disabled

Remarks¶

The version of OAuth being used. The following options are available: Disabled,1.0,2.0

OAuthClientId¶

The client ID assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret¶

The client secret assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken¶

The access token for connecting using OAuth.

Data Type¶

string

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.

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:

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.

CallbackURL¶

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type¶

string

Default Value¶

""

Remarks¶

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthGrantType¶

The grant type for the OAuth flow.

Possible Values¶

CODE, CLIENT, PASSWORD

Data Type¶

string

Default Value¶

CLIENT

Remarks¶

The grant type for the OAuth flow. The following options are available: CODE,CLIENT,PASSWORD

OAuthPasswordGrantMode¶

How to pass Client ID and Secret with OAuthGrantType is set to Password.

Possible Values¶

Post, Basic

Data Type¶

string

Default Value¶

Post

Remarks¶

The OAuth RFC specifies two methods of passing the OAuthClientId and OAuthClientSecret when using the Password OAuthGrantType. The most commonly used is to pass them via post data to the service. However, some services may require that you pass them via the Authorize header as to be used in BASIC authorization. Change this property to Basic to submit the parameters as part of the Authorize header instead of the post data.

OAuthIncludeCallbackURL¶

Whether to include the callback URL in an access token request.

Data Type¶

bool

Default Value¶

true

Remarks¶

This defaults to true since standards-compliant OAuth services will ignore the redirect_uri parameter for grant types like CLIENT or PASSWORD that do not require it.

This option should only be enabled for OAuth services that report errors when redirect_uri is included.

OAuthAuthorizationURL¶

The authorization URL for the OAuth service.

Data Type¶

string

Default Value¶

""

Remarks¶

The authorization URL for the OAuth service. At this URL, the user logs into the server and grants permissions to the application. In OAuth 1.0, if permissions are granted, the request token is authorized.

OAuthAccessTokenURL¶

The URL to retrieve the OAuth access token from.

Data Type¶

string

Default Value¶

""

Remarks¶

The URL to retrieve the OAuth access token from. In OAuth 1.0, the authorized request token is exchanged for the access token at this URL.

OAuthRefreshTokenURL¶

The URL to refresh the OAuth token from.

Data Type¶

string

Default Value¶

""

Remarks¶

The URL to refresh the OAuth token from. In OAuth 2.0, this URL is where the refresh token is exchanged for a new access token when the old access token expires.

OAuthRequestTokenURL¶

The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0.

Data Type¶

string

Default Value¶

""

Remarks¶

The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. In OAuth 1.0, this is the URL where the app makes a request for the request token.

OAuthVerifier¶

The verifier code returned from the OAuth authorization URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines¶

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

AuthToken¶

The authentication token used to request and obtain the OAuth Access Token.

Data Type¶

string

Default Value¶

""

Remarks¶

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

AuthKey¶

The authentication secret used to request and obtain the OAuth Access Token.

Data Type¶

string

Default Value¶

""

Remarks¶

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

OAuthParams¶

A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.

Data Type¶

string

Default Value¶

""

Remarks¶

A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.

OAuthRefreshToken¶

The OAuth refresh token for the corresponding OAuth access token.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn¶

The lifetime in seconds of the OAuth AccessToken.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp¶

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type¶

string

Default Value¶

""

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.

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:

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¶

The type of key store containing the JWT Certificate.

Possible Values¶

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB, GOOGLEJSON, GOOGLEJSONBLOB

Data Type¶

string

Default Value¶

USER

Remarks¶

This property can take one of the following values:

OAuthJWTCertPassword¶

The password for the OAuth JWT 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 in order to open the certificate store.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.

OAuthJWTCertSubject¶

The subject of the OAuth JWT 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 instance "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Common fields and their meanings are displayed below.

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. This is typically either the Client ID or Email Address of the OAuth Application.

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. Typically, the user account name or email address.

Kerberos¶

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

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: The connector will infer the Kerberos Realm and Kerberos KDC from the configured domain name and host as a last resort.

KerberosRealm¶

The Kerberos Realm used to authenticate the user with.

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: The connector will infer the Kerberos Realm and Kerberos KDC from the user-configured domain name and host as a last resort. This might work in some Windows environments.

KerberosSPN¶

The service principal name (SPN) for the Kerberos Domain Controller.

Data Type¶

string

Default Value¶

""

Remarks¶

If the SPN on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, use this property to set the SPN.

KerberosKeytabFile¶

The Keytab file containing your pairs of Kerberos principals and encrypted keys.

Data Type¶

string

Default Value¶

""

Remarks¶

The Keytab file containing your pairs of Kerberos principals and encrypted keys.

The Keytab file containing your pairs of Kerberos principals and encrypted keys.

KerberosServiceRealm¶

The Kerberos realm of the service.

Data Type¶

string

Default Value¶

""

Remarks¶

The KerberosServiceRealm is the specify the service Kerberos realm when using cross-realm Kerberos authentication.

In most cases, a single realm and KDC machine are used to perform the Kerberos authentication and this property is not required.

This property is available for complex setups where a different realm and KDC machine are used to obtain an authentication ticket (AS request) and a service ticket (TGS request).

KerberosServiceKDC¶

The Kerberos KDC of the service.

Data Type¶

string

Default Value¶

""

Remarks¶

The KerberosServiceKDC is used to specify the service Kerberos KDC when using cross-realm Kerberos authentication.

In most cases, a single realm and KDC machine are used to perform the Kerberos authentication and this property is not required.

This property is available for complex setups where a different realm and KDC machine are used to obtain an authentication ticket (AS request) and a service ticket (TGS request).

KerberosTicketCache¶

The full file path to an MIT Kerberos credential cache file.

Data Type¶

string

Default Value¶

""

Remarks¶

This property can be set if you wish to use a credential cache file that was created using the MIT Kerberos Ticket Manager or kinit command.

SSL¶

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

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:

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:

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.

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:

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.

SSHAuthMode¶

The authentication method to be used to log on to an SFTP server.

Possible Values¶

None, Password, Public_Key

Data Type¶

string

Default Value¶

Password

Remarks¶

• None: No authentication will be performed. The current User value is ignored, and the connection will be logged in as anonymous.
• Password: The connector will use the values of User and Password to authenticate the user.
• Public_Key: The connector will use the values of User and SSHClientCert to authenticate the user. SSHClientCert must have a private key available for this authentication method to succeed.

SSHClientCert¶

A certificate to be used for authenticating the user.

Data Type¶

string

Default Value¶

""

Remarks¶

In order to use public key authentication, SSHClientCert must contain a certificate with a valid private key. The certificate's public key value is sent to the server along with a signature produced using the private key. The server will first check to see if the public key values match what is known for the user and then will attempt to use those values to verify the signature.

The SSHClientCertType field specifies the type of the certificate store specified by SSHClientCert. If the store is password protected, specify the password in SSHClientCertPassword.

SSHClientCert is used in conjunction with the SSHClientCertSubject

field in order to specify client certificates. If SSHClientCert has a value, and SSHClientCertSubject is set, a search for a certificate is initiated. Please refer to the SSHClientCertSubject 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:

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

SSHClientCertPassword¶

The password of the SSHClientCert certificate if it has one.

Data Type¶

string

Default Value¶

""

Remarks¶

This property is only used when authenticating to SFTP servers with SSHAuthMode set to PublicKey and SSHClientCert set to a private key.

SSHClientCertType¶

The type of SSHClientCert certificate.

Possible Values¶

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, P7BFILE, P7BBLOB, SSHPUBLIC_KEY_FILE, PPKFILE, PPKBLOB, XMLFILE, XMLBLOB

Data Type¶

string

Default Value¶

PUBLIC_KEY_FILE

Remarks¶

The type of SSHClientCert certificate. This property can take one of the following values:

Schema¶

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

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:

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.

Charset¶

Specifies the session character set for encoding and decoding character data transferred to and from the Excel file. The default value is UTF-8.

Data Type¶

string

Default Value¶

UTF-8

Remarks¶

Specifies the session character set for encoding and decoding character data transferred to and from the 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'.

Data Type¶

string

Default Value¶

""

Remarks¶

This option affects the format of connector output. To specify the format that defines how input should be interpreted, use the Culture option. By default the connector uses the current locale settings of the machine to interpret input and format output.

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.

Data Type¶

string

Default Value¶

""

Remarks¶

This property affects the connector input. To interpret values in a different cultural format, use the Client Culture property. By default the connector uses the current locale settings of the machine to interpret input and format output.

CustomHeaders¶

Other headers as determined by the user (optional).

Data Type¶

string

Default Value¶

""

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.

The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by the carriage return and line feed (CRLF) characters.

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for fine-tuning the functionality of the connector to integrate with specialized or nonstandard APIs.

CustomUrlParams¶

The custom query string to be included in the request.

Data Type¶

string

Default Value¶

""

Remarks¶

The CustomUrlParams allow you to specify custom query string parameters that are included with the HTTP request. The parameters must be encoded as a query string in the form field1=value1&field2=value2&field3=value3. The values in the query string must be URL encoded.

IncludeDropboxTeamResources¶

Indicates if you want to include Dropbox team files and folders.

Data Type¶

bool

Default Value¶

false

Remarks¶

In order to access Dropbox team folders and files, please set this connection property to True.

MaxRows¶

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Data Type¶

int

Default Value¶

-1

Remarks¶

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other¶

These hidden properties are used only in specific use cases.

Data Type¶

string

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¶

PseudoColumns¶

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

Data Type¶

string

Default Value¶

""

Remarks¶

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

RowScanDepth¶

The maximum number of rows to scan to look for the columns available in a table.

Data Type¶

int

Default Value¶

15

Remarks¶

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

Timeout¶

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type¶

int

Default Value¶

60

Remarks¶

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.