Adding a Connection to Microsoft Excel Online

To add a connection to Microsoft Excel Online:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Microsoft Excel Online icon is not available, click the Add More icon to download and install the Microsoft Excel Online connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Microsoft Excel Online

There are two authentication methods available for connecting to Microsoft Excel Online data source:

• OAuth 2.0-based methods: Microsoft Excel Online provides OAuth 2.0-based authentication via both Azure AD and Azure Service Principal.
  • For Azure AD authentication, set AuthScheme to AzureAD.
  • For Azure Service Principal authentication, set AuthScheme to AzureServicePrincipal.
• Managed Service Identity (MSI) authentication. To use this method, set AuthScheme to AzureMSI.

Azure AD

Azure AD is user-based authentication. Credentials are supplied to connect AzureAD to Microsoft Excel Online via a Desktop application. To use the embedded credentials for authentication, leave the OAuth credentials (OAuthClientId and OAuthClientSecret) blank.

For connecting via a Web application, you must create a custom OAuth Azure AD application. The creation of a Custom Azure AD application establishes the OAuth credentials OAuthClientId and OAuthClientSecret. For a discussion of how to create a custom Azure AD application, and reasons why that might be advantageous even if you are not connecting via a Web application, see Creating an Entra ID (Azure AD) Application.

Azure Service Principal

The authentication as an Azure Service Principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself. All tasks taken by the application are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

Create an AzureAD App and an Azure Service Principal

When authenticating using an Azure Service Principal, you must create and register an Azure AD application with an Azure AD tenant. See Creating an Entra ID (Azure AD) Application for more details.

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

Assign a role to the application

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

1. Open the Subscriptions page by searching and selecting the Subscriptions service from the search bar.
2. Select the subscription to assign the application to.
3. Open the Access control (IAM) and select Add > Add role assignment to open the Add role assignment page.
4. Select Owner as the role to assign to your created Azure AD app.

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

Client Secret

Set these connection properties:

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

Certificate

Set these connection properties:

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

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

Managed Service Identity (MSI)

If you are running Microsoft Excel Online on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials to connect, set AuthScheme to AzureMSI.

User-Managed Identities

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's client_id.

If your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.

Connecting to a Workbook

The Sync App exposes workbooks and worksheets from drives you specify in your Microsoft account. You can connect to a workbook by providing authentication to Excel Online and setting any of the following properties.

To control which drives are discovered:

• Drive: The ID of a specific drive. You can use the Drives and SharePointSites views to view all the sites and drives you have access to.
• SharepointURL: The browser URL of a SharePoint site. The driver exposes all drives under the site.
• OAuthClientId: If AuthScheme is set to AzureServicePrincipal, the drive associated with your OAuth application is exposed.

If none of the above are specified, access is restricted to the authenticated user's personal drive.

To control which workbooks and worksheets are exposed OR which drives are exposed:

• Workbook: The name or Id of the workbook. An authenticate user can view a list of information about the available workbooks by executing a query to the Workbooks view.
• UseSandbox: True to connect to a workbook in a sandbox account; otherwise, leave blank.
• BrowsableSchemas: A list of drive names to expose.
• Tables: A list of table names to expose.

Executing SQL Against Worksheet Data

For information on how to execute data manipulation SQL against worksheets and ranges, see:

• Selecting ExcelOnline Data
• Inserting ExcelOnline Data
• Updating ExcelOnline Data
• Deleting ExcelOnline Data
• Using Formulas

For details on how the Sync App models worksheets and cells as tables and columns, See Data Model.

Retrieving Data from SharePoint Excel Files

To retrieve data from Sharepoint Excel files, set the SharepointURL connection property to the URL of your Sharepoint site. For example,

 SharepointURL=https://mysite.sharepoint.com/ 

The driver automatically looks up each document library you have in SharePoint and lists it as a schema. Individual Excel workbooks and worksheets are listed as tables in the format Workbook_Worksheet under their corresponding document library. This works in the same manner as listing your own personal Excel documents when SharepointURL is not set.

The following connection properties enable you to execute SELECT queries that closely match how your sheet is organized.

Selecting Column Headers

If your worksheet has column headers, you can set the Header property to use column names defined in a header row. Then you can query like so:

SELECT Id, Name, Item, Quantity, Amount FROM Test_xlsx_Sheet1 WHERE Amount = 50

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

Selecting Alphabetical Columns

If a workbook does not have headers, or if you would like to ignore the headers, you can set the Header property to false. In this case each column is represented by alphabetical names. For example:

SELECT A, B, C, D FROM Test_xlsx_Sheet1 WHERE D = 50

Selecting Ranges

Instead of working with the spreadsheet as a single table, you can work with ranges as tables. Some examples: In a sparse workbook, you can use ranges to select data without the empty rows. Or, in a worksheet that is not top-left aligned, you can use a range to select data in the middle of the sheet.

To select a range of data on the worksheet, append the range to the table name with the # character. For example, the following command will select the range of cells between A1 and E5:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

To assign a table name to a range, and avoid specifying the range repeatedly, see the Tables property.

You can execute INSERT statements when working with worksheets as tables. You can specify the column names detected from a header row or specify the alphabetical column names in Excel Online. You can also configure how the Sync App parses the input values into Microsoft Excel Online cell formats.

Set the Header property to configure column names. Set ValueInputOption to configure input parsing.

Note that inserting to ranges is not supported. Use Batch Inserts or Temporary Tables instead.

Inserting with Headers

When the Header property is set to true, you can specify cells in a header row as the column names.

INSERT INTO Test_xlsx_Sheet1 (Name, Amount) VALUES ('Test', 10)

Inserting without Headers

When the Header property is set to false, provide the alphabetical column names.

INSERT INTO Test_xlsx_Sheet1 (A, B) VALUES ('Test', 10)

Configuring Input Parsing

By default, the Sync App parses all values you input in the SQL statement the same as if you entered the input in the Microsoft Excel Online UI. For example, strings may be converted to numbers, dates, etc.

To disable the parsing of input values, set ValueInputOption. Additionally, see Using Formulas to configure formula evaluation.

Example: Bulk Inserts using Temporary Tables

If using temporary tables, they must be defined and inserted within the same connection. Closing the connection will clear out any temporary tables in memory.

Creating Temporary Tables

Insert the rows you need in a temporary table. Then insert all the rows from that temporary table into the actual table.

In UPDATE statements, you can specify the column names detected from a header row or specify the alphabetical column names in Microsoft Excel Online. You can also configure how the Sync App parses the input values into Microsoft Excel Online cell formats.

Set the Header property to configure column names. The primary key is the row number; specify the primary key with the Id column. Set ValueInputOption to configure input parsing.

Updating with Headers

When the Header property is set to true, you update columns by specifying the detected column names.

UPDATE Customers SET Col1='value' WHERE Id=7

Updating without Headers

When the Header is set to false, provide the alphabetical column names:

UPDATE Customers SET H='value' WHERE Id=7

Updating Ranges

Set the columns corresponding to the range and specify the row number as the Id:

UPDATE [Customers#A15:C15] SET A='Ana Trujilo', B='Northwind, Inc.', C='100,000' WHERE Id='15'

Configuring Input Parsing

By default, the Sync App parses all values you input in the SQL statement the same as if you entered the input in the Microsoft Excel Online UI. For example, strings may be converted to numbers, dates, etc.

To disable the parsing of input values, set ValueInputOption. Additionally, see Using Formulas to configure formula evaluation.

When deleting an entire row of data, you will need to be sure to refresh the table data. This is because Ids are assigned based on the row. For example, if there are five rows, with Ids 1 through 5, and you delete row 3 then row 4 will become 3 and 5 will become 4.

Set the following properties to configure formula evaluation when executing SELECT, INSERT, and UPDATE statements.

Selecting Formulas

The Sync App can return either the result of the formula or the formula itself; configure this behavior with the ValueRenderOption connection property.

Inserting and Updating Formulas

Set AllowFormula to true to insert formulas (the default). Otherwise, all values used in inserts and updates are inserted as string literals.

For example, with AllowFormula set to true, 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)')

Note: If AllowFormula is set to true, every column containing a formula will be exposed as String type regardless of the set TypeDetectionScheme.

This section details a selection of advanced features of the Microsoft Excel Online Sync App.

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

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

For further information, see Query Processing.

Logging

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

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Workbooks as Tables

The Sync App models the worksheets and ranges in your workbooks as bidirectional tables. When you connect, the Sync App retrieves the metadata from Microsoft Excel Online and reflects any changes to the table schemas.

See the Getting Started section for quickstarts to executing SQL to the tables. This section provides additional details on the Sync App behavior.

Tables

This section provides more detail about how the Sync App models the Tables. See Columns for details about column discovery.

Stored Procedures

In addition to working with the data in the workbook, you can use the available stored procedures to access functionality in the Microsoft Excel Online API that is not modeled as SELECT, INSERT, UPDATE, or DELETE statements; for example, the AddWorksheet stored procedure.

System Tables

Query the available System Tables to access the available Sync App metadata, including schema information.

Best Practices

1) If you currently have many workbooks or sheets in your account, it may take a long time to initially retrieve all the data. You may shorten this time by adding the Workbook connection property to your connection string.

2) If you will be running a SELECT operation after INSERT or BATCH INSERT then make sure to wait 3-5 seconds before running it. The API takes a few seconds to register all the data you're adding to the database, so waiting is required to avoid partial results.

The Sync App exposes worksheets from workbooks as tables. To do so, it exposes the drives containing these workbooks and worksheets as schemas for these tables. How drives are exposed as schemas is dependent on the connection propeties for the Sync App.

The following connection properties determine what drives are exposed as schemas by the driver. They are listed in order of precedence, where only the most precedent property is used to expose schemas:

• Drive: The ID of a specific drive. Only this drive is exposed as schema.
• SharepointURL: The browser URL of a SharePoint site. The driver will expose all drives under the site. All of these drives are exposed as schemas.
• OAuthClientId: If AuthScheme is set to AzureServicePrincipal, the drive associated with your OAuth app is exposed. Only this drive is exposed as schema.
• If none of the above are specified, the personal drive for the authenticated user is used. Only this drive is exposed as schema.

To view all the sites and drives to which you have access, use the Drives and SharePointSites views.

To filter the schemas the driver exposes, use the BrowsableSchemas connection property. Supply a list of drive names to this property. The filtering is done client-side, so this means that the names supplied should be the names that would normally be returned by the Sync App for the drives.

The Sync App enables you to represent a top-left-oriented worksheet or a user-specified range as a database table.

Top-Left Oriented Worksheets

You can use the Sync App to start working right away with top-left-oriented worksheets:

• The table name for a top-left-oriented worksheet is the name of the worksheet.
• By default the Sync App will return all rows until the first empty row. Note: an empty row between data will prevent further data from being returned.
• The first row of data in the worksheet can contain the column names. See Columns for more information.

User-Specified Ranges

Range notation is only available in a SELECT or UPDATE statement. Ranges are not supported for DELETE and INSERT commands.

You can execute SELECT or UPDATE commands against a given range with a reference in the following format: WORKSHEET#RANGE. You can also set the Tables property to assign a table name to a range.

For example, the following command will select the range of cells between A1 and E5:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

Accessing shared documents as a database table

You can use the connection property ShowSharedDocuments to list shared excel workbooks as database tables. The tables will be listed along-side user owned workbooks.

Executing SQL to Worksheet Data

See the following to execute data manipulation SQL to worksheets and ranges:

• Selecting ExcelOnline Data
• Inserting ExcelOnline Data
• Updating ExcelOnline Data
• Deleting ExcelOnline Data
• Using Formulas

When you connect, the Sync App discovers the available columns and reflects both changes in Microsoft Excel Online and configuration changes you make with the following connection properties. See the following sections to configure aspects of column discovery specific to Microsoft Excel Online.

Configuring Column Name Detection

You can set Header to detect column names in a header row or you can reference columns alphabetically.

Header=True (Default)

Below are more specifics on how the Sync App detects column names from a header row when Header is set to true.

• The Sync App determines columns from the first row of the worksheet. If no values are provided for the first row of the worksheet, the Sync App creates unique, alphabetized column names that are available only within the scope of that request.
• Headers should not contain special characters.
• Due to a limitation of the Excel Online API, all column headers must be nonempty.

Header=False

When Header is set to false, alphabetical column names will be dynamically assigned.

Primary Key

The Sync App reports the row number as the primary key. The Id column for each row represents the row number from the top of the sheet.

For example, if you specify a range A3:E6, rows 3, 4, 5, and 6 will be returned.

Configuring Column Value Parsing

The ValueRenderOption and ValueInputOption connection properties can be used to configure how the Sync App parses the Microsoft Excel Online cell formats in SELECT, INSERT and UPDATE operations.

Value render options for SELECT operations

Set the ValueRenderOption to configure how the Sync App renders values in the output of a SELECT operation. The available value render options are as below.

• FormattedValue: Values will be calculated and formatted in the output according to the cell's formatting. Formatting is based on the workbook's locale, not the requesting user's locale. This is the default ValueRenderOption.
• UnformattedValue: Values will be calculated but not formatted in the output.
• Formula: Values will not be calculated and instead the output will include the formulas. For this reason, every column containing a formula will be exposed as String type regardless of the set TypeDetectionScheme.

Value input options for INSERT and UPDATE operations

Set the ValueInputOption to configure how the Sync App parses values the user submits to the Microsoft Excel Online source for INSERT and UPDATE operations. The available value input options are as below.

• UserEntered: The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc., following the same rules that are applied when entering text into a cell via the Microsoft Excel Online UI. This is the default ValueInputOption.
• Raw: The values the user has entered will not be parsed and will be stored as-is.

Configuring Data Type Detection

Set the TypeDetectionScheme to configure the data type detection method. The available type detection schemes are as below.

• RowScan: The Sync App will scan rows to heuristically determine the data type. The number of rows the Sync App will scan can be determinated by the RowScanDepth property. This is the default TypeDetectionScheme.
• ColumnFormat: The Sync App will report the data type based on the cell format of the column. This option is applicable only for the 'UnformattedValue' and 'Formula' ValueRenderOption-s. If the ValueRenderOption is set to 'FormattedValue', all columns will be exposed as String types.
• None: The Sync App will return all columns as the string type.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Microsoft Excel Online Connector for CData Sync Views

Name	Description
Drives	Retrieve a list of drive objects.
Folders	Retrieve a list of Folder objects.
SharedDocuments	Retrieve the list of all shared documents. Not every item listed by this view can be used as a workbook since the driver will filter out non excel files. See the Workbook and Worksheets views for more information.
SharePointSites	Retrieve the list of all sites in your SharePoint account.
Workbooks	Retrieve a list of workbook objects.
Worksheets	Retrieve a list of worksheet objects. If listing sheets in a workbook which do not belong to the user's drive, please specify the drive id using the Drive connection property.

Retrieve a list of drive objects.

Select

The example query below will return the Drives with the specified SharePointSite Id.

SELECT * FROM Drives WHERE SiteId = 'rssbus.onmicrosoft.com,988a3-343a-4064-996a-d2a30559f,4233d-dfcd-4910-b7f0-71f1dc03a'

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the drive.
SiteId	String	SharePointSites.Id	The ID of the SharePoint site or subsite that this drive belongs to.
ListId	String		The ID of the list this drive corresponds to.
Name	String		The name of the drive.
Description	String		The description of the drive.
CreatedByName	String		The display name of the identity.
CreatedById	String		Unique identifier for the identity.
CreatedDateTime	Datetime		Date and time the drive was created.
LastModifiedDateTime	Datetime		Date and time the drive was last modified.
WebUrl	String		URL that displays the resource in the browser.

Retrieve a list of Folder objects.

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the folder.
Name	String		The Name of the folder
DriveId	String	Drives.Id	The ID of the drive that this folder belongs to.
ParentPath	String		The path of the folder's parent.
ParentId	String		The id of the folder's parent.
ParentName	String		The name of the folder's parent.
CreatedByName	String		The display name of the identity.
CreatedById	String		Unique identifier for the identity.
CreatedDateTime	Datetime		Date and time the item was created.
LastModifiedDateTime	Datetime		Date and time the item was last modified.

Retrieve the list of all shared documents. Not every item listed by this view can be used as a workbook since the driver will filter out non excel files. See the Workbook and Worksheets views for more information.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the shared document
SharedFileId	String		The shared file Id of the document.
DriveId	String		The drive Id where this document resides.
Name	String		The name of the shared document.
Size	String		The size of the shared document.
SharedByUserName	String		The name of the user who shared this document.
SharedDateTime	String		The date and time when this document was shared.
CreatedDateTime	Datetime		The date and time when this document was created.
LastModifiedDateTime	Datetime		The date and time when this document was last modified.
WebUrl	String		The web URL of this shared document.

Retrieve the list of all sites in your SharePoint account.

Table Specific Information

In contrast to almost every other exposed table and view, this view does not implement any Microsoft Graph endpoint, but rather the '/query/search' endpoint of the SharePoint REST API. For this reason, in most cases you will need to specify the SharepointURL connection property prior to initiating the OAuth flow. During the Authorization flow, the Sync App will get the necessary permissions to utilize your SharePoint resources.

Select

The Sync App will use the SharePoint REST API to process WHERE clause conditions built with almost every column except for Id, and only for the EQUALS (=) operator. The rest of the filter is executed client side within the Sync App.

The example query below will return the SharePoint Site with the specified SiteId and WebId.

SELECT SiteId, SiteName, Title, SiteDescription FROM SharePointSites WHERE SiteId = '9839b8a3-343a-4064-996a-d2a300bc559f' AND WebId = '427d733d-dfcd-4910-b7f0-771f1d4cc03a'

Restrictions

To query this view using the 'AzureServicePrincipal' AuthScheme, you must specify the OAuthJWTCert instead of the OAuthClientSecret connection property. The restriction is imposed by the SharePoint REST API, which does not accept any OAuthAccessToken retrieved when specifying an OAuthClientSecret for the aforementioned authentication flows.

For a guide on how to authentication using a Certificate for the 'AzureAD' and 'AzureServicePrincipal' AuthSchemes, see "Client Credentials" in "Getting Started".

Columns

Name	Type	References	Description
Id [KEY]	String		The full identifier of the site.
SiteId	String		The unique identifier of the site collection.
WebId	String		The Web Id of the site.
SiteName	String		The name of the site.
Title	String		The title of the site.
SiteDescription	String		The description of the site.
Description	String		The description of the item.
CreatedDateTime	Datetime		Date and time the site was created.
LastModifiedDateTime	Datetime		Date and time the site was last modified.
SPWebUrl	String		URL that displays the resource in the browser.
Author	String		The author of the site.
DocumentSignature	String		The document signature of the site.
FileExtension	String		The extension of the site's file.
SecondaryFileExtension	String		The secondary extension of the site's file.
FileType	String		The file type of the site.
DocId	Long		The unique identifier of the site within a geo location.
GeoLocationSource	String		The geo location of the site.
HitHighlightedSummary	String		The heighted summary of the site.
Importance	Long		The importance of the site.
IsContainer	Bool		Specifies whether the site is a folder.
IsDocument	Bool		Specifies whether the site is a document.
OriginalPath	String		The original site path.
Path	String		The current site path.
Rank	Double		The rank of the site.
RenderTemplateId	String		The site's control render template name.
SiteLogo	String		The URI of the site's logo.
ViewsLifeTime	Long		The total view count since the site was created.
ViewsRecent	Long		The total view count of the site in the last 14 days.
WebTemplate	String		The web temple from which the site is created.

Retrieve a list of workbook objects.

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the item within the Drive.
Name	String		The name of the item.
CreatedByName	String		The display name of the identity.
CreatedById	String		Unique identifier for the identity.
CreatedDateTime	Datetime		Date and time the item was created.
LastModifiedDateTime	Datetime		Date and time the item was last modified.
Size	Long		Size of the item in bytes.
WebUrl	String		URL that displays the resource in the browser.
DriveId	String	Drives.Id	The ID of the drive that this workbook belongs to.

Retrieve a list of worksheet objects. If listing sheets in a workbook which do not belong to the user's drive, please specify the drive id using the Drive connection property.

Columns

Name	Type	References	Description
Id [KEY]	String		Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved.
WorkbookId	String	Workbooks.Id	The Id of the workbook containing this worksheet.
Name	String		The display name of the worksheet.
Position	Integer		The zero-based position of the worksheet within the workbook.
Visibility	String		The visibility of the worksheet. Possible values are: Visible, Hidden, VeryHidden.

The connection string 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 in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Microsoft Excel Online. If this property is left blank, the default authentication is used.
UseSandbox	A boolean indicating if you are using a sandbox account. The provider makes requests to the production environment by default.

Connection

---

Property	Description
Workbook	The name or Id of the workbook.
Drive	Specifies the Id of the drive. A list of all drives is available from the Drives view.
FolderId	Specifies the Id of the folder.
IncludeSharePointSites	Specifies whether or not drives for all SharePoint sites are retrieved when querying Drives view. (Note: This property only affects Drives views.

Azure Authentication

---

Property	Description
AzureTenant	Identifies the Microsoft Excel Online tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	A space-seperated list of scopes.
State	Optional value for representing extra OAuth state information.

JWT OAuth

---

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

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Header	Indicates whether or not the provider should detect column names from the first row.
IncludePrimaryKey	Controls whether the driver includes an auto-generated primary key column in the table definition.
PrimaryKeyIdentifier	Specifies the name of the primary key column that holds the row number.
DefineTables	Defines the ranges within a worksheet that will appear as tables.
IncludePreRangeColumns	Controls whether to include columns that appear before the specified Excel range.

Miscellaneous

---

Property	Description
TypeDetectionScheme	Specifies the method for identifying the data types of columns.
AllowFormula	Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates.
IncludeFileExtensions	Specifies whether file extensions should be included in table names.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
NullValueMode	Specifies whether empty cells are read as NULL or as empty strings.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	The maximum number of results to return per page from Microsoft Excel Online when UsePagination is True.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
SeparatorCharacter	Specifies the character used to separate the workbook name and worksheet name in the generated table name.
SharepointURL	The base URL of your Sharepoint Server.
ShowEmptyRows	Indicates whether the rows that contain no data (empty rows) should be pushed to the output.
ShowSharedDocuments	Whether or not to show shared documents.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UsePagination	Whether to use client-side paging.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseSearchAPI	Specifies whether the CData ADO.NET Provider for Microsoft Excel Online should use the /search(q='.xls') endpoint to locate and retrieve workbook files. When set to true (default) , the driver performs a targeted search to list only workbook files, improving efficiency in large directories. If set to false, all items are listed using the /children endpoint, and workbook files are filtered client-side.
UseSessions	Specifies whether to use sessions when connecting to Excel Online through the Microsoft Graph API.
UseSimpleNames	Specifies whether or not simple names should be used for tables and columns.
ValueInputOption	Determines how the provider parses values the user submits to Microsoft Excel Online.
ValueRenderOption	Determines how the provider renders values in the output.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Microsoft Excel Online. If this property is left blank, the default authentication is used.
UseSandbox	A boolean indicating if you are using a sandbox account. The provider makes requests to the production environment by default.

Specifies the type of authentication to use when connecting to Microsoft Excel Online. If this property is left blank, the default authentication is used.

Remarks

AuthScheme values include:

• AzureAD (default): Perform Azure Active Directory (user-based) OAuth authentication.
• AzureMSI: Automatically obtain Azure AD Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Authenticate as an Azure Service Principal (role-based, application-based) using a Client Secret.
• AzureServicePrincipalCert: Authenticate as an Azure Service Principal (role-based, application-based) using a Certificate.

For information about creating a custom application to authenticate with Azure AD, see Creating an Entra ID (Azure AD) Application.

For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating a Service Principal App in Entra ID (Azure AD).

A boolean indicating if you are using a sandbox account. The provider makes requests to the production environment by default.

Remarks

If you are using a production account, this property can be left blank. If you are using a developer test account, set this to true.

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

---

Property	Description
Workbook	The name or Id of the workbook.
Drive	Specifies the Id of the drive. A list of all drives is available from the Drives view.
FolderId	Specifies the Id of the folder.
IncludeSharePointSites	Specifies whether or not drives for all SharePoint sites are retrieved when querying Drives view. (Note: This property only affects Drives views.

The name or Id of the workbook.

Remarks

Specifies the name or Id of the workbook. A list of all workbooks is available from the Workbooks view.

Specifies the Id of the drive. A list of all drives is available from the Drives view.

Remarks

This property takes precedence over SharepointURL. This means that if SharepointURL and Drive are specified, a schema will only be identified for the drive specified by Drive, and tables will only be identified from the worksheets in workbooks in this drive.

Specifies the Id of the folder.

Remarks

For a list of all folders, see the Folders view.

Specifies whether or not drives for all SharePoint sites are retrieved when querying Drives view. (Note: This property only affects Drives views.

Remarks

If True, the Sync App retrieves all Site IDs recursively, and for each of them issues a separate call to get their drives. Be aware that setting this property to True may decrease performance for the Drives view.

Note: If the AuthScheme is AzureServicePrincipal and IncludeSharePointSites is set to True, you must also set the SharePointAccessToken or OAuthJWTCert connection property in order to query views such as SharePointSites.

This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AzureTenant	Identifies the Microsoft Excel Online tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Identifies the Microsoft Excel Online tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.

Remarks

A tenant is a digital container for your organization's users and resources, managed through Microsoft Entra ID (formerly Azure AD). Each tenant is associated with a unique directory ID, and often with a custom domain (for example, microsoft.com or contoso.onmicrosoft.com).

To find the directory (tenant) ID in the Microsoft Entra Admin Center, navigate to Microsoft Entra ID > Properties and copy the value labeled "Directory (tenant) ID".

This property is required in the following cases:

• When AuthScheme is set to AzureServicePrincipal or AzureServicePrincipalCert
• When AuthScheme is AzureAD and the user account belongs to multiple tenants

You can provide the tenant value in one of two formats:

• A domain name (for example, contoso.onmicrosoft.com)
• A directory (tenant) ID in GUID format (for example, c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0)

Specifying the tenant explicitly ensures that the authentication request is routed to the correct directory, which is especially important when a user belongs to multiple tenants or when using service principal–based authentication.

If this value is omitted when required, authentication may fail or connect to the wrong tenant. This can result in errors such as unauthorized or resource not found.

Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Remarks

Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	A space-seperated list of scopes.
State	Optional value for representing extra OAuth state information.

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

A space-seperated list of scopes.

Remarks

This connection property is only used for the AzureAD authentication flow. It defaults to the following: https://graph.microsoft.com/Sites.Read.All https://graph.microsoft.com/Sites.ReadWrite.All https://graph.microsoft.com/Files.Read https://graph.microsoft.com/Files.Read.All https://graph.microsoft.com/Files.Read.Selected https://graph.microsoft.com/Files.ReadWrite https://graph.microsoft.com/Files.ReadWrite.All https://graph.microsoft.com/Files.ReadWrite.AppFolder https://graph.microsoft.com/Files.ReadWrite.Selected.

Optional value for representing extra OAuth state information.

Remarks

Optional value for representing extra OAuth state information.

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

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

Supplies the name of the client certificate's JWT Certificate store.

Remarks

The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Sync App initiates a search for a certificate. For further information, see OAuthJWTCertSubject.

Designations of certificate stores are platform-dependent.

Notes

• The most common User and Machine certificate stores in Windows include:
  • MY: A certificate store holding personal certificates with their associated private keys.
  • CA: Certifying authority certificates.
  • ROOT: Root certificates.
  • SPC: Software publisher certificates.
• In Java, the certificate store normally is a file containing certificates and optional private keys.
• When the certificate store type is PFXFile, this property must be set to the name of the file.
• When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Identifies the type of key store containing the JWT Certificate.

Remarks

Value	Description	Notes
USER	A certificate store owned by the current user.	Only available in Windows.
MACHINE	A machine store.	Not available in Java or other non-Windows environments.
PFXFILE	A PFX (PKCS12) file containing certificates.
PFXBLOB	A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	A Java key store (JKS) file containing certificates.	Only available in Java.
JKSBLOB	A string (base-64-encoded) representing a certificate store in Java key store (JKS) format.	Only available in Java.
PEMKEY_FILE	A PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	A string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	A file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	A file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	A string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	A PKCS7 file containing certificates.
PPKFILE	A file that contains a PPK (PuTTY Private Key).
XMLFILE	A file that contains a certificate in XML format.
XMLBLOB	Astring that contains a certificate in XML format.
BCFKSFILE	A file that contains an Bouncy Castle keystore.
BCFKSBLOB	A string (base-64-encoded) that contains a Bouncy Castle keystore.

Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

• If an exact match for the subject is found, the corresponding certificate is selected.
• If no exact match is found, the store is searched for certificates whose subjects contain the property value.
• If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected].

Common fields include:

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".

The issuer of the Java Web Token.

Remarks

The issuer of the Java Web Token. In most cases, this takes the value of the OAuth App Id (Client Id) connection property and does not need to be individually set.

The user subject for which the application is requesting delegated access.

Remarks

The user subject for which the application is requesting delegated access. In most cases, this takes the value of the OAuth App Id (Client Id) connection property and does not need to be individually set.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

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

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Microsoft Excel Online. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Microsoft Excel Online. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Microsoft Excel Online. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

Supported authentication types :

• BASIC: The Sync App performs HTTP basic authentication.
• DIGEST: The Sync App performs HTTP digest authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The username of a user registered with the proxy server.
DIGEST	The username of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Header	Indicates whether or not the provider should detect column names from the first row.
IncludePrimaryKey	Controls whether the driver includes an auto-generated primary key column in the table definition.
PrimaryKeyIdentifier	Specifies the name of the primary key column that holds the row number.
DefineTables	Defines the ranges within a worksheet that will appear as tables.
IncludePreRangeColumns	Controls whether to include columns that appear before the specified Excel range.

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\ExcelOnline Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Indicates whether or not the provider should detect column names from the first row.

Remarks

If Header is set to True, the first row is used as a column header. If Header is set to False, the pseudo column names A, B, C, etc. are used.

The Sync App also follows these rules for detecting column headers:

• Headers should not contain special characters.
• Due to a limitation of the Excel Online API, all column headers must be nonempty.

Controls whether the driver includes an auto-generated primary key column in the table definition.

Remarks

When IncludePrimaryKey is set to True (default), the driver adds a primary key column (id) to each table. The column name can be customized using the PrimaryKeyIdentifier property. When IncludePrimaryKey is set to False, the driver omits the auto-generated primary key column entirely and returns only the columns defined in the source data.

Disabling this option forces the driver to search all matching rows instead of relying directly on the primary key column. This impacts performance for UPDATE and DELETE operations.

Specifies the name of the primary key column that holds the row number.

Remarks

Set this property if there is a column named "Id" in the table you are querying, or if you prefer to change the name of the primary key.

If no value is supplied for PrimaryKeyIdentifier, the CData Sync App uses the default value of Id for the primary key.

Defines the ranges within a worksheet that will appear as tables.

Remarks

The value for this property is supplied as a semicolon-separated list of name-value pairs in the form [Table Name]=[Catalog].[Schema].[{Workbook Name}_{Worksheet Name}!{Range}].

The value can also be specified in the form [Table Name]=[{Workbook Name}_{Worksheet Name}!{Range}]. Note that in this case, the driver will attempt to push the defined table for each schema it identifies, should the specified workbook and worksheet exist in the schema.

Sometimes, specifications of DefineTables include characters, like ., that can interfere with the parsing of the command unless they are protected ("escaped"). To protect such specifications, surround the name containing the protected character with angle brackets; for example, [work.book_work.sheet!A1:Z50]). This enables the command to be parsed properly. In the previous example, the driver searches for the workbook and worksheet identified by work.book_work.sheet, even though the specification includes reserved characters.

After you set DefineTables, you can issue queries that reference the specified table name. Note that you can also use the range syntax directly in the SQL statement: append the range to the worksheet name with the # character.

For example, the following command selects the range of cells between A1 and E5:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

Example

DefineTables="Table1=Test_xlsx_Sheet1!A1:N25,Table2=[CData].[MySchema].[Spreadsheet1_Sheet2!C3:M53],Table4=xIsPcLs2-bF3AavQcSLCfzs3kGc_Sheet4!C20:N60"

Controls whether to include columns that appear before the specified Excel range.

Remarks

If true, includes all columns from column A up to the start of the specified range. Otherwise, only includes columns within the specified range.

Example, for a range 'C1:E5':

• If true: Shows columns A, B, C, D, and E
• If false: Shows only columns C, D, and E

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
TypeDetectionScheme	Specifies the method for identifying the data types of columns.
AllowFormula	Whether or not to treat values starting with an equals (=) sign as formulas during inserts and updates.
IncludeFileExtensions	Specifies whether file extensions should be included in table names.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
NullValueMode	Specifies whether empty cells are read as NULL or as empty strings.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	The maximum number of results to return per page from Microsoft Excel Online when UsePagination is True.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
SeparatorCharacter	Specifies the character used to separate the workbook name and worksheet name in the generated table name.
SharepointURL	The base URL of your Sharepoint Server.
ShowEmptyRows	Indicates whether the rows that contain no data (empty rows) should be pushed to the output.
ShowSharedDocuments	Whether or not to show shared documents.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UsePagination	Whether to use client-side paging.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseSearchAPI	Specifies whether the CData ADO.NET Provider for Microsoft Excel Online should use the /search(q='.xls') endpoint to locate and retrieve workbook files. When set to true (default) , the driver performs a targeted search to list only workbook files, improving efficiency in large directories. If set to false, all items are listed using the /children endpoint, and workbook files are filtered client-side.
UseSessions	Specifies whether to use sessions when connecting to Excel Online through the Microsoft Graph API.
UseSimpleNames	Specifies whether or not simple names should be used for tables and columns.
ValueInputOption	Determines how the provider parses values the user submits to Microsoft Excel Online.
ValueRenderOption	Determines how the provider renders values in the output.

Specifies the method for identifying the data types of columns.

Remarks

The Sync App can detect data types with the cell format (number, currency, date, etc.) or by scanning rows.

Allowed values are:

• None: Returns all columns as the string type.
• RowScan: Scans rows to heuristically determine the data type. The RowScanDepth property determines the number of rows the Sync App scans.
• ColumnFormat: Reports the data type based on the cell format of the column.

  Note: This option is applicable only when ValueRenderOption is set to UnformattedValue. If ValueRenderOption is set to FormattedValue or Formula, all columns are exposed as string types.

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

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.

For example, with AllowFormula set to true, 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)')

Note: If True, every column containing a formula will be exposed as String type regardless of the set TypeDetectionScheme.

Specifies whether file extensions should be included in table names.

Remarks

When set to true, file extensions are appended to the base table name, making the format [WorkbookName].[extension]_[WorksheetName] instead of the default [WorkbookName]_[WorksheetName].

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies whether empty cells are read as NULL or as empty strings.

Remarks

An empty cell is a cell that has not been set, and thus contains a null string. Permitted values:

• ReadAsNull: An empty cell is reported as NULL.
• ReadAsEmpty: An empty cell is reported as an empty string.
• ReadAsEmptyOrNull: An empty cell in a string column is reported as an empty string, and an empty cell in other columns is reported as NULL.

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Integration and Formatting

Property	Description
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

The maximum number of results to return per page from Microsoft Excel Online when UsePagination is True.

Remarks

The Pagesize property controls the maximum number of results returned per page from Microsoft Excel Online. Setting a higher value may improve performance by reducing the number of round trips, but will consume more memory per page. Special considerations: - SharePointSites table: Has a default page size of 500 and will not accept larger values. This table honours the Pagesize property independently without requiring UsePagination to be enabled. - Setting Pagesize to -1 enables dynamic page sizing, which optimizes performance by adjusting the page size based on the data being retrieved. With this setting, results will be retrieved in a serial manner rather than using parallel processing.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

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

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.

Specifies the character used to separate the workbook name and worksheet name in the generated table name.

Remarks

The separator character is inserted between the workbook and worksheet names when forming the table name.

For example:

• If set to "_": MyWorkbook_Sheet1
• If set to "-": MyWorkbook-Sheet1
• If set to "#": MyWorkbook#Sheet1

The base URL of your Sharepoint Server.

Remarks

To query the SharePointSites, this base URL of your Sharepoint Server must be specified. A protocol prefix, either "http://" or "https://", must be provided in the value supplied for this property.

For example: https://SomeTenantName.sharepoint.com. This property can also be used to control what drives, workbooks, and worksheets are exposed by the Sync App. If you specify SharepointURL and do not specify Drive, the Sync App will enumerate drives from the specified site as schemas, and enumerate all the worksheets from all the workbooks in each drive as tables in their respective schema. If this property is specified when using AzureServicePrincipal or AzureServicePrincipalCert authentication, the search endpoint will not be used. This property must be specified if working with a custom application that has Sites.Selected as its highest privilege.

Indicates whether the rows that contain no data (empty rows) should be pushed to the output.

Remarks

If true, the empty rows are pushed to the output and included in the result set. If false, the output only contains rows that have at least one non-empty value.

Whether or not to show shared documents.

Remarks

Whether or not to show shared documents. If set to true, shared documents will be listed along-side user owned workbooks as database tables. Ultimately, the specific files should have been granted direct access or explicitly shared with the authenticated user.

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Whether to use client-side paging.

Remarks

Whether to use client-side paging. As a best practice, set this option to true in the case of a large dataset.

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

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

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

Specifies whether the CData ADO.NET Provider for Microsoft Excel Online should use the /search(q='.xls') endpoint to locate and retrieve workbook files. When set to true (default) , the driver performs a targeted search to list only workbook files, improving efficiency in large directories. If set to false, all items are listed using the /children endpoint, and workbook files are filtered client-side.

Remarks

Set this property to true to use the /search(q='.xls') endpoint for efficient workbook retrieval, particularly in large directories. If issues occur with this endpoint, set the property to false to retrieve all items and filter them client-side.

Specifies whether to use sessions when connecting to Excel Online through the Microsoft Graph API.

Remarks

When this property is set to true, the Sync App creates a persistent session with the Graph API for Excel Online, improving data consistency and performance for multiple operations.

When UseSessions is set to false, each operation uses its own session instead of reusing a persistent one, which can reduce performance and data consistency.

Important: Always close connections when finished. Failure to do so prevents the session from being terminated and can lead to unnecessary server resource consumption.

It is recommended to keep this option enabled (default) for optimal performance and data reliability.

Specifies whether or not simple names should be used for tables and columns.

Remarks

Microsoft Excel Online tables can include special characters in their names that are typically not allowed in standard databases. This property makes the Sync App easier to use with traditional database tools.

Setting UseSimpleNames to True simplifies the names of the columns that are returned. It enforces a naming scheme where only alphanumeric characters and underscores are valid for displayed column names.

Notes:

• Any non-alphanumeric characters are converted to underscores.
• If the column or table names exceed 128 characters in length they are truncated to 128 characters to comply with SQL Server standards.

Determines how the provider parses values the user submits to Microsoft Excel Online.

Remarks

Determines how the Sync App parses values the user submits to Microsoft Excel Online.

Raw	The values the user has entered will not be parsed and will be stored as-is.
UserEntered	The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc., following the same rules that are applied when entering text into a cell via the Excel Online UI.

Determines how the provider renders values in the output.

Remarks

Allowed values are:

• FormattedValue: Values are calculated and formatted in the reply according to the cell's formatting. Formatting is based on the workbook's locale, not the requesting user's locale. For example, if A1 is 1.23 and A2 is "=A1" and formatted as currency, then A2 would return "$1.23".
• UnformattedValue: Values are calculated but not formatted in the reply. For example, if A1 is 1.23 and A2 is "=A1" and formatted as currency, then A2 would return the number 1.23.

  Note: When TypeDetectionScheme is set to RowScan, the Sync App determines the data types based on the data returned by the API. Since date and time fields are returned by the API as int/double (for example, November 15, 2025 is stored as 45954 in Microsoft Excel Online's 1900 date system), the Sync App detects these fields as integers rather than dates when using RowScan. To ensure proper date/time detection, set TypeDetectionScheme to ColumnFormat when using the UnformattedValue option.

• Formula: Values are not calculated and instead the reply includes the formulas. For example, if A1 is 1.23 and A2 is "=A1" and formatted as currency, then A2 would return "=A1". For this reason, every column containing a formula will be exposed as String type regardless of the set TypeDetectionScheme.

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.