Create a connection to Smartsheet by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Smartsheet icon is not available, click the Add More icon to download and install the Smartsheet connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Smartsheet supports connections via the following authentication methods:

• Using the Personal Access Token
• Using OAuth

Personal Access Token

Use the personal token to test and to access your own data. To obtain the personal token, follow the steps below:

1. Log into Smartsheet.
2. Click Account and select Personal Settings.
3. Click API Access and use the form to generate new access tokens or manage existing access tokens.

OAuth

Smartsheet uses the OAuth authentication standard. To use it, you'll need to set the AuthScheme to OAuth. To authenticate using OAuth, you will need to register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

However, to access your own account or for testing purposes you can instead set the PersonalAccessToken connection property to the Personal Access Token you get when you create an application.

For more information, refer to our Using OAuth Authentication guide.

This section details a selection of advanced features of the Smartsheet Sync App.

User Defined Views

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

SSL Configuration

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

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 Smartsheet and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

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

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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.

The CData Sync App models the Smartsheet API as relational tables, views, and stored procedures. Views are tables that cannot be modified.

Static Tables

Some API objects, like Workspaces, Folders, etc., are indexed with 'Info_'. These are defined in schema files, which are simple, text-based configuration files.

Dynamic Tables

You can work with all the Sheets and Reports in your account using the Sync App. In addition to providing information about the static tables, the data model illustrates a sample of what your Sheets and Reports might look like. The actual data model will be obtained dynamically based on your user credentials.

When you connect, the Sync App gets the list of tables and the metadata for the tables by calling the appropriate Web services. Any changes you make to your Smartsheet account, such as adding a new table, adding new columns, or changing the data type of a column, will immediately be reflected when you connect using the Sync App.

Stored Procedures

Stored Procedures are function-like interfaces to Smartsheet. They can be used to search, update, and modify information in Smartsheet.

API Restrictions

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

The Sync App models the data in Smartsheet into a list of tables that can be queried using standard SQL statements.

Generally, querying Smartsheet tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Smartsheet Connector for CData Sync Tables

Query Smartsheet Attachments. Attachments can exist on a Comment (i.e., within a Discussion), on a Row, or on a Sheet.

Table Specific Information

Select

When getting data from this table the queries might be slow if you have a lot of sheets. To counter this, specifying SheetId is recommended. Also other parameters like DiscussionId, RowId, CommentId can be specified to get Attachments to the related object.

Retrieve all Attachments from all Sheets.

SELECT * FROM Info_Attachments

Retrieve all Attachments related to a Sheet.

SELECT * FROM Info_Attachments WHERE SheetId='2940085806098308'

Retrieve all Attachments related to a discussion.

SELECT * FROM Info_Attachments WHERE SHEETId='2940085806098308' AND DiscussionId='8206230771525508'

Retrieve all Attachments related to a Row.

SELECT * FROM Info_Attachments WHERE SheetId='2940085806098308' AND RowId='6773684447799172'

Retrieve all Attachments related to a Comment.

SELECT * FROM Info_Attachments WHERE SheetId='2940085806098308' AND CommentId='1322606759569284'

Retrieve details of a specific Attachment.

SELECT * FROM Info_Attachments WHERE Id='3053958945105796' AND SheetId='2940085806098308'

Insert

You can attach a file to a specific row in a specific sheet. Fields required for Insert are SheetId, RowId, Name of the file and either FilePath or ContentEncoded.

INSERT INTO Info_Attachments (SheetId, RowId, Name, FilePath) VALUES('8179839304787844','4728727909230468', 'TestSheet.xlsx', 'G:\\\\TestSheet.xlsx')

INSERT INTO Info_Attachments (SheetId, RowId, Name, ContentEncoded) VALUES('8179839304787844','4728727909230468', 'TestSheet.xlsx', 'dGVzdGluZyBlbmNvZGVkIHRleHQ=')

Columns

Query Smartsheet Comments in a Discussion.

Table Specific Information

Select

This view returns details for Columns of a specified Discussion. The SheetId parameter is always required.

Retrieve all comments from a sheet.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308'

Retrieve details of a specified Comment.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308' AND Id='1322606759569284'

Insert

You can insert a comment to a discussion by providing SheetId, DiscussionId and Text.

INSERT INTO Info_Comments (SheetId, DiscussionId, Text) VALUES ('568679927703428', '4661021235275652', 'This is a comment 3')

Columns

Query Smartsheet Discussions. A Discussion is a collection of one or more Comments. A Discussion can exist on a Row or a Sheet.

Table Specific Information

Select

This view returns a list of Discussions. The SheetId parameter is always required.

Retrieve all Discussions related to a Sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308'

Retrieve Discussions related to a specific Row of a Sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308' AND RowId='6773684447799172'

Retrieve details of a specified Comment.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308' AND Id='8206230771525508'

Insert

You can insert a discussion to a sheet by providing SheetId and FirstDiscussionComment. To add a discussion to a row, provide RowId, SheetId, and FirstDiscussionComment.

INSERT INTO Info_Discussions (SheetId, FirstDiscussionComment) VALUES ('568679927703428', 'This is a comment 1')

INSERT INTO Info_Discussions (RowId, SheetId, FirstDiscussionComment) VALUES ('1889077216995204', '568679927703428', 'This is a comment 2')

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Create, update, delete, and query the Sheet_Content_Calendar table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Customer_Order_Tracking_History table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Event_Plan_Budget table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Expense_Report table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Gantt_Project_with_Hard_Deadline table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Job_Candidate_Tracker table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Sales_Activity_Tracking_by_Rep_Month table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Simple_Sales_Pipeline table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Team_Objectives_Tracker table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_Team_Task_List_by_Priority table in Smartsheet.

Columns

Create, update, delete, and query the Sheet_WebFormTest table in Smartsheet.

Columns

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Smartsheet Connector for CData Sync Views

Query the available CellHistory of a Cell in Smartsheet.

Table Specific Information

Select

To get data from this view a SheetId, RowId, and ColumnId are always required.

Retrieve Cell History.

SELECT * FROM Info_CellHistory WHERE SheetId = '2940085806098308' AND RowId='6773684447799172' AND ColumnId='7999197812156292'

Columns

Query Smartsheet Cells. A collection of Cells comprises each Row in a Sheet.

Table Specific Information

Select

This view returns details for Cells of a specified Row. The SheetId and RowId parameters are always required.

Retrieve Cells.

SELECT * FROM Info_Cells WHERE SheetId = '2940085806098308' AND RowId='6773684447799172'

Columns

Query Smartsheet Columns in a Sheet or Report.

Table Specific Information

Select

This view returns details for Columns of a specified Sheet. The SheetId parameter is always required.

Retrieve Columns.

SELECT * FROM Info_Columns WHERE SheetId = '2940085806098308'

Retrieve details of the specified Columns.

SELECT * FROM Info_Columns WHERE SheetId = '2940085806098308' AND Id='7999197812156292'

Columns

Query Smartsheet Contacts. A Contact is the personal contact of a User in Smartsheet.

Table Specific Information

Select

This view returns details for Contacts.

Retrieve Contacts.

SELECT * FROM Info_Contacts

Retrieve details of a specified Contact.

SELECT * FROM Info_Contacts WHERE Id='1322606759569284'

Columns

Query Smartsheet Favorites.

Table Specific Information

Select

This view returns a list of Favorite objects.

Retrieve all Favorite objects.

SELECT * FROM Info_Favorites

Columns

Query Smartsheet Folders in the Sheets Folder for the User, in another Folder, or in a Workspace.

Table Specific Information

Select

Retrieve all Folders.

SELECT * FROM Info_Folders

Retrieve details for a Folder.

SELECT * FROM Info_Folders WHERE Id='2035256120371076'

Retrieve Folders of a specified Workspace.

SELECT * FROM Info_Folders WHERE WorkspaceId = '2940085806098308'

Columns

Query Smartsheet Groups.

Table Specific Information

Select

Retrieve all Groups.

SELECT * FROM Info_Groups

Retrieve details for a Group.

SELECT * FROM Info_Groups WHERE Id='2035256120371076'

Columns

Query objects on the Home tab in Smartsheet. The Home tab shows all objects a User has access to.

Table Specific Information

Select

Retrieve all objects located on the Home tab:

SELECT * FROM Info_Home

Columns

Query Smartsheet Reports.

Table Specific Information

Select

Retrieve all Reports.

SELECT * FROM Info_Reports

Retrieve Reports located in a specific Workspace.

SELECT * FROM Info_Reports WHERE WorkspaceId='6773684447799172'

Retrieve Reports located in a specific Folder.

SELECT * FROM Info_Reports WHERE FolderId='6773684447799172'

Columns

Query Rows in a Sheet or Report. Each Row is composed of a collection of Cells, and may optionally contain Discussions and Attachments.

Table Specific Information

Select

This view returns a list of Sheet Rows. The SheetId parameter is always required.

Retrieve all Rows of a Sheet.

SELECT * FROM Info_Rows WHERE SheetId = '2940085806098308'

Retrieve details of a specified Row.

SELECT * FROM Info_Rows WHERE SheetId = '2940085806098308' AND Id='8206230771525508'

Columns

Query Smartsheet Server Information including application constants.

Table Specific Information

Select

Retrieve Server Information:

SELECT * FROM Info_ServerInformation

Columns

Query the Sharing operations of Reports, Sheets, and Workspaces.

Table Specific Information

Select

This view returns a list of Shares. Either the SheetId or WorkspaceId parameter is always required.

Retrieve all Shares related to a Sheet.

SELECT * FROM Info_Shares WHERE SheetId = '2940085806098308'

Retrieve all Shares related to a Workspace.

SELECT * FROM Info_Shares WHERE WorkspaceId = '1630085806098114'

Retrieve details of a Share related to a specified Sheet.

SELECT * FROM Info_Shares WHERE SheetId = '2940085806098308' AND Id='1928085806875098'

Retrieve details of a Share related to a specified Workspace.

SELECT * FROM Info_Shares WHERE WorkspaceId = '1630085806098114' AND Id='2928085806875091'

Columns

Query Smartsheets Sheets. A Sheet can exist in the Sheets folder for the user (Home), in a Folder, or in a Workspace. It is comprised of Columns, Rows, and Cells, and may optionally contain Attachments and Discussions.

Table Specific Information

Select

Retrieve all Sheets.

SELECT * FROM Info_Sheets

Retrieve Sheets located in a specific Folder.

SELECT * FROM Info_Sheets WHERE FolderId = '2928085806875091'

Retrieve Sheets located in a specific Workspace.

SELECT * FROM Info_Sheets WHERE WorkspaceId = '1928085806875098'

Columns

Query Smartsheet Templates.

Table Specific Information

Select

By default this view returns all Templates created by the user. If the TemplateType filter is set to 'public' , the public templates will be returned.

Retrieve all Templates.

SELECT * FROM Info_Templates

Retrieve all other public Templates.

SELECT * FROM Info_Templates WHERE TemplateType = 'public'

Retrieve Templates located on a specific folder.

SELECT * FROM Info_Templates WHERE FolderId = '2928085806875091'

Retrieve Templates located on a specific Workspace.

SELECT * FROM Info_Templates WHERE WorkspaceId = '1928085806875098'

Columns

Query the Users in the organization.

Table Specific Information

Select

Retrieve all Users.

SELECT * FROM Info_Users

Retrieve all Users of a specific Group.

SELECT * FROM Info_Users WHERE GroupId='2928085806875091'

Columns

Query Smartsheet Workspaces.

Table Specific Information

Select

Retrieve all Workspaces.

SELECT * FROM Info_Workspaces

Retrieve all details for a specific Workspace.

SELECT * FROM Info_Workspaces WHERE Id = '2928085806875091'

Columns

The Smartsheet table Report_Sales_Activity_And_Team_Objectives.

Columns

Query the Report_Tasks_and_Events view in Smartsheet.

Columns

Data Type Mappings

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

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.

Authentication

OAuth

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

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

Whether to use Personal Access Token Authentication or OAuth Authentication when connecting to Smartsheet.

Remarks

Whether to use Personal Access Token Authentication or OAuth Authentication when connecting to Smartsheet

The Personal Access Token that can be generated from the Smartsheet UI.

Remarks

The Personal Access Token that can be generated from the Smartsheet UI.

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

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

Remarks

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

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

Remarks

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

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

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

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

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

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

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

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that 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.

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

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

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

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

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

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

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

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

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

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

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

Note that 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, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

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

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

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Smartsheet Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

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

Remarks

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

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

Remarks

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

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

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

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

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

Remarks

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

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

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

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

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

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

Remarks

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

The Sync App will follow the additional specifications below to detect column headers:

• Headers should not contain special characters.
• All column headers must be nonempty.

Set to True if you want to hide currency symbols and percentage signs in numeric values. This will also convert these columns from varchar to double. Only works if TypeDetectionScheme is set to RowScan and at least the first RowScanDepth values for that column are convertable to double.

Remarks

Set to True if you want to hide currency symbols and percentage signs in numeric values. This will also convert these columns from varchar to double. Only works if TypeDetectionScheme is set to RowScan and at least the first RowScanDepth values for that column are convertable to double.

If set to false and any of the specified Row IDs are not found, no rows will be deleted, and a 'not found' error will be returned.

Remarks

If set to false and any of the specified Row IDs are not found, no rows will be deleted, and a 'not found' error will be returned.

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

Remarks

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

These hidden properties are used only in specific use cases.

Remarks

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

The maximum number of results to return per page from Smartsheet.

Remarks

The Pagesize property affects the maximum number of results to return per page from Smartsheet. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

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

Remarks

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

Controls whether new functionality, such as multi-contact data is returned as: Backwards-compatible, text format (level 0, default) Multi-contact data (level 1) Multi-contact data (report-compatible, level 2) Multi-picklist data (level 3) .

Remarks

The minimum level required to get data for 'report' tables is 2.

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.

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

Remarks

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

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

Determines how to determine the data types of columns.

Remarks

Whether or not to include the full file path in the name of an exposed table or view, corresponding to a sheet or report.

Remarks

If set to true, the names of the exposed sheets as tables and reports as views, will include the full file path. Ex. SalesSheets_Agents_MonthlyReports_Sheet_JuneSheet.

If set to false, the tables and views corresponding to the sheets and reports, will be exposed using only the file's name. Ex. Sheet_JuneSheet.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

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

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

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

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

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

Boolean determining if simple names should be used for tables and columns.

Remarks

Smartsheet tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App easier to use with traditional database tools.

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

Indicates whether the cell will use the Value fields as its value or the DisplayValue field.

Remarks

• If Auto the driver will use which field its not empty.
• If Value the driver will use the Value field.
• If DisplayValue the driver will use the DisplayValue field.