Smartsheet Connector for CData Sync

Build 25.0.9539
  • Smartsheet
    • Establishing a Connection
      • Creating a Custom OAuth Application
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Hyperlink Columns
      • Tables
        • Info_Attachments
        • Info_Columns
        • Info_Comments
        • Info_Discussions
        • Info_Folders
        • Info_Groups
        • Info_Users
        • Info_Workspaces
        • Sheet_Content_Calendar
        • Sheet_Customer_Order_Tracking_History
        • Sheet_Event_Plan_Budget
        • Sheet_Expense_Report
        • Sheet_Gantt_Project_with_Hard_Deadline
        • Sheet_Job_Candidate_Tracker
        • Sheet_Sales_Activity_Tracking_by_Rep_Month
        • Sheet_Simple_Sales_Pipeline
        • Sheet_Team_Objectives_Tracker
        • Sheet_Team_Task_List_by_Priority
        • Sheet_WebFormTest
      • Views
        • Info_AttachmentVersions
        • Info_CellHistory
        • Info_Cells
        • Info_Contacts
        • Info_DashboardPublishSettings
        • Info_Dashboards
        • Info_DashboardShares
        • Info_Favorites
        • Info_Home
        • Info_ReportPublishSettings
        • Info_Reports
        • Info_ReportShares
        • Info_Rows
        • Info_ServerInformation
        • Info_SheetPublishSettings
        • Info_Sheets
        • Info_SheetShares
        • Info_Templates
        • Info_WorkspaceShares
        • Report_Sales_Activity_And_Team_Objectives
        • Report_Tasks_and_Events
      • Stored Procedures
        • CopyRowsToAnotherSheet
        • CopySheet
        • CreateSchema
        • CreateSheet
        • DeleteAttachment
        • DeleteDashboardShare
        • DeleteReportShare
        • DeleteSheet
        • DeleteSheetShare
        • DeleteUser
        • DeleteWorkspaceShare
        • DownloadAttachment
        • GetOAuthAccessToken
        • GetOAuthAuthorizationURL
        • ImportFile
        • MoveRowsToAnotherSheet
        • MoveSheet
        • RefreshOAuthAccessToken
        • ShareDashboard
        • ShareReport
        • ShareSheet
        • ShareWorkspace
        • UpdateDashboardShare
        • UpdateReportShare
        • UpdateSheetShare
        • UpdateWorkspaceShare
        • UploadAttachment
        • UploadAttachmentVersion
      • Data Type Mapping
    • Connection String Options
      • Authentication
        • AuthScheme
        • PersonalAccessToken
      • Connection
        • Region
        • UseLegacyAPI
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • Header
        • HideFormattingCharacters
        • IgnoreRowsNotFound
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • ReportCompatibilityLevel
        • RowScanDepth
        • Timeout
        • TypeDetectionScheme
        • UseFullFilePathsAsTableNames
        • UseIdAsTableName
        • UserDefinedViews
        • UseSimpleNames
        • ValueSource
    • Third Party Copyrights

Smartsheet Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Smartsheet data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Smartsheet connector can be used from the CData Sync application to pull data from Smartsheet and move it to any of the supported destinations.

Smartsheet Version Support

The Sync App defaults to version 2.0 of the Smartsheet API. Later versions can be specified in the property.

Smartsheet Connector for CData Sync

Establishing a Connection

Adding a Connection to Smartsheet

To add a connection to Smartsheet:

  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 Smartsheet icon is not available, click the Add More icon to download and install the Smartsheet 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 Smartsheet

Smartsheet supports connections via the following authentication methods:

  • Using the Personal Access Token

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.
Set the AuthScheme to PersonalAccessToken. You can then set the PersonalAccessToken to the token you generated.

Synch Connections

Before you connect, set the following variables:

  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Click Connect to Smartsheet to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver then completes the OAuth process as follows:

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

Smartsheet Connector for CData Sync

Creating a Custom OAuth Application

Note: Creating an OAuth application requires a Smartsheet developer account.

To register an app and obtain the OAuth client credentials, the client Id and client secret:

  1. Log into your Smartsheet developer account.
  2. Click Account > Developer Tools > Create New App.
  3. Enter a name, description, and other information to be displayed to users when they log in to grant permissions to your app.
  4. Set other parameters, depending on the type of application you are creating:
    • For desktop applications, set the Redirect URL to http://localhost:33333 or a different port number of your choice.
    • For Web applications, set the Redirect URL to the page where the user should return after they authorize your application.

Smartsheet Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Smartsheet 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 Smartsheet 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.

Smartsheet Connector for CData Sync

SSL Configuration

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.

Smartsheet Connector for CData Sync

Firewall and Proxy

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.

Smartsheet Connector for CData Sync

Data Model

The CData Sync App models the Smartsheet data as an easy-to-use SQL database.

Tables

The data model of the Sync App is dynamic. This means that, when you connect using the Sync App, any changes you make in the Smartsheet UI, such as adding a new table, adding new columns, or changing a column's data type, are automatically included in the schema of the Sync App.

However, some tables and views, such as workspaces and folders, are static. These are defined in schema files, which are simple, text-based configuration files. The static tables and views are prefixed with 'Info_'.

Common tables include:

Table Description
Info_Sheets Explore detailed metadata and structure of Smartsheet sheets, including their components like columns, rows, and attachments.
Info_Rows Retrieve detailed row data, including cells, discussions, and attachments, for enhanced row-level analysis.
Info_Columns Retrieve metadata and properties of columns in Smartsheet sheets or reports, essential for understanding sheet structures.
Info_Cells Explore individual cell data in Smartsheet rows, offering granular insights into sheet contents.
Info_Attachments Retrieve detailed information about Smartsheet attachments, which can be associated with comments, rows, or sheets, providing a comprehensive view of file dependencies.
Info_Comments Access comments within discussions in Smartsheet, providing insights into collaboration history.
Info_Discussions Analyze discussion threads, including comments, tied to specific rows or sheets for better communication tracking.
Info_Users Query user data within an organization for administrative and reporting purposes.
Info_Workspaces Access workspace-level details, including sheets and folders, for better organizational insights.
Info_Folders Explore folder structures in Smartsheet, including user-level folders and workspace organization.
Info_Reports Query Smartsheet reports, providing insights into custom aggregated data across sheets.
Info_Templates Retrieve Smartsheet template information to streamline the creation of standardized sheets.
Info_Groups Retrieve group information for enhanced user management and role-based permissions in Smartsheet.
Info_Contacts Query Smartsheet user contact details, facilitating management of personal and shared connections.
Info_Home Access items available on the Smartsheet Home tab, offering a centralized view of user-permissible objects.
Info_Favorites Retrieve a user's favorite items in Smartsheet, helping prioritize frequently accessed content.
Info_ServerInformation Access Smartsheet server information and application constants, useful for API integrations.
Info_CellHistory Access the historical changes of specific cells in Smartsheet, enabling detailed audit and tracking capabilities.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including managing sheets and attachments, and retrieving OAuth credentials.

API Restrictions

The Sync App uses the Smartsheet API to process supported filters. The Sync App processes other filters client-side within the Sync App.

Smartsheet Connector for CData Sync

Hyperlink Columns

You can add hyperlink columns to table schema files generated by the CreateSchema stored procedure.

After generating a schema file from the desired table, add a new column (attr) as follows:

  • Set other:columnid to a unique value (any string that isn't already taken by another column).
  • Add an other:hyperlink attribute to the column. Set this attribute to the value in the name attribute of the column you want your new hyperlink column to display hyperlinks for.

    These two values must match exactly.

For example, suppose you have this column in your schema file:

<attr name="MyColumnName" xs:type="string" ... other:columnid="5555555555555555"/>

Your new hyperlink column attached to this column should look like this:

<attr name="nameLink" xs:type="string" ... other:columnid="YourUniqueIDHere" other:hyperlink="MyColumnName"/>

Smartsheet Connector for CData Sync

Tables

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

Smartsheet Connector for CData Sync Tables

Name Description
Info_Attachments Read and upload attachments in the sheets of your Smartsheet account.
Info_Columns Read and write properties of columns in your Smartsheet sheets.
Info_Comments Read and write comment data on your Smartsheet sheets.
Info_Discussions Read and write discussions data on your Smartsheet sheets.
Info_Folders Read and write folders data in your Smartsheet account.
Info_Groups Read and write groups data in your Smartsheet account.
Info_Users Read and write users data in your Smartsheet account.
Info_Workspaces Read and write workspace data in your Smartsheet account.

Smartsheet Connector for CData Sync

Info_Attachments

Read and upload attachments in the sheets of your Smartsheet account.

Table Specific Information

SELECT

Queries on this table may be slow if your account contains many sheets. To improve performance, specify SheetId. You can also use DiscussionId, RowId, or CommentId to retrieve attachments for the related object.

Retrieve all attachments from all sheets.

SELECT * FROM Info_Attachments

Retrieve all attachments in a specific sheet.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308'

Retrieve all attachments in a specific discussion.

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

Retrieve all attachments in a specific row of a sheet.

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

Retrieve all attachments in a specific comment of a sheet.

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

Retrieve details of a specific attachment in a sheet.

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

INSERT

You can create an attachment in:
  • A sheet. In this case, the SheetId column is required.
  • A row in a sheet. In this case, the SheetId and RowId columns are required.
  • A comment in a sheet. In this case, the SheetId and CommentId columns are required.

The Name column is required in every case. Other required columns vary depending on the type of attachment you are creating. Refer to the query examples below.

INSERT INTO Info_Attachments (SheetId, Name, AttachmentType, URL) VALUES ('2940085806098308', 'Link Attachment', 'LINK', 'https://cdata.com')
INSERT INTO Info_Attachments (SheetId, RowId, Name, AttachmentType, AttachmentSubType, URL) VALUES ('2940085806098308', '6773684447799172', 'Sheet Attachment', 'GOOGLE_DRIVE', 'SPREADSHEET', 'https://docs.google.com/spreadsheets/d/xxxx_yyyy/edit?usp=drive_link')

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier of the attachment.

Name String False

The name of the attachment.

Url String False

The temporary URL of the attachment.

UrlExpiresInMillis Long True

The temporary URL time to live for the attachment.

AttachmentType String False

The attachment type. Possible values are: 'FILE', 'GOOGLE_DRIVE', 'LINK', 'BOX_COM', 'DROPBOX', 'EVERNOTE', and 'EGNYTE'.

AttachmentSubType String False

The attachment subtype, valid only for either 'GOOGLE_DRIVE' attachments or 'EGNYTE' attachments. Possible values for 'GOOGLE_DRIVE' attachments: 'DOCUMENT', 'SPREADSHEET', 'PRESENTATION', 'PDF', 'DRAWING'. Possible values for 'EGNYTE' attachments: 'FOLDER'.

CreatedAt Timestamp True

A timestamp of when the attachment was originally added.

UserId String True

The unique identifier of the user who created the attachment.

UserEmail String True

The email address of the user who created the attachment.

UserName String True

The full name of the user who created the attachment.

MimeType String True

Attachment MIME type. For example 'PNG'.

ParentType String True

The type of the object the attachment belongs to. Possible values: 'SHEET', 'ROW', or 'COMMENT'.

ParentId String True

The unique identifier of the object the attachment belongs to.

SizeInKb Long True

The size of the file, if the attachment is a file.

SheetId String False

The Id of the sheet.

RowId String False

The Id of the row.

DiscussionId String True

The Id of the discussion.

CommentId String False

The Id of the comment.

Description String False

The description of the attachment.

Smartsheet Connector for CData Sync

Info_Columns

Read and write properties of columns in your Smartsheet sheets.

Table-specific Information

SELECT

This table returns details for columns in a specified sheet. The SheetId column is always required in the criteria.

Retrieve all columns in a sheet.

SELECT * FROM Info_Columns WHERE SheetId = '568679927703428'

Retrieve details of a specific column in the sheet.

SELECT * FROM Info_Columns WHERE SheetId = '568679927703428' AND Id = '1967782344478596'

INSERT

You can create a new column in the sheet by providing the SheetId, Index, Title, and Type properties as shown in the example query below.
INSERT INTO Info_Columns (SheetId, Index, Title, Type) VALUES ('568679927703428', 1, 'Test Column 1', 'TEXT_NUMBER')

UPDATE

You can update the properties of a column in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.
UPDATE Info_Columns SET Index = 3, Title = 'Transportation', Type = 'PICKLIST', OptionsAggregate = '["ship", "motorcycle", "airplane"]', Hidden = false, Width = 30, Locked = false, LockedForUser = false WHERE SheetId = '568679927703428' AND Id = '1967782344478596'

DELETE

You can delete one of the columns in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.
DELETE FROM Info_Columns WHERE SheetId = '568679927703428' AND Id = '1967782344478596'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier for the column, used to reference it programmatically.

Index Integer False

The numeric position of the column in the sheet, starting at 0 for the first column.

Title String False

The displayed name of the column, as shown in the Smartsheet interface.

Primary Boolean True

Indicates whether this column is the primary column, which typically contains key identifiers or names for rows.

Type String False

The functional data type of the column, determining how data is stored and validated.

The allowed values are TEXT_NUMBER, CHECKBOX, DATE, DATETIME, ABSTRACT_DATETIME, PICKLIST, MULTI_PICKLIST, CONTACT_LIST, MULTI_CONTACT_LIST, DURATION, PREDECESSOR.

OptionsAggregate String False

A list of selectable options for the column, applicable for columns like dropdowns or picklists.

ContactOptions String False

Array of the contact options available for the column.

Hidden Boolean False

Indicates whether the column is hidden in the Smartsheet interface.

Symbol String False

Represents visual markers or indicators used in the column, with values varying by column type (for example, checkboxes, picklists).

The allowed values are ARROWS_3_WAY, ARROWS_4_WAY, ARROWS_5_WAY, DECISION_SHAPES, DECISION_SYMBOLS, DIRECTIONS_3_WAY, DIRECTIONS_4_WAY, EFFORT, HARVEY_BALLS, HEARTS, MONEY, PAIN, PRIORITY, PRIORITY_HML, PROGRESS, RYG, RYGB, RYGG, SIGNAL, SKI, STAR_RATING, VCR, WEATHER.

ColumnType String False

The system-defined column type.

The allowed values are AUTO_NUMBER, CREATED_BY, CREATED_DATE, MODIFIED_BY, MODIFIED_DATE.

TagsAggregate String True

Defines system tags for the column, used to indicate roles in features like Gantt charts or calendars (for example, 'gantt_duration').

Width Integer False

The pixel width used to display the column in the sheet's user interface.

Format String False

The applied formatting settings for the column, such as text alignment or date format.

FilterType String True

Specifies the type of filter applied to the column, with options such as 'list' for predefined values or 'custom' for user-defined filters.

Locked Boolean False

Indicates whether the column is locked, preventing edits by all users except the owner or admin.

LockedForUser Boolean False

Indicates whether the column is locked for the current user based on their permissions.

SheetId String False

The unique identifier of the sheet to which this column belongs.

Smartsheet Connector for CData Sync

Info_Comments

Read and write comment data on your Smartsheet sheets.

Table-Specific Information

SELECT

This table returns details for comments in a sheet. The SheetId column is always required and must be specified in the criteria.

Retrieve all comments from a sheet.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308';
SELECT * FROM Info_Comments WHERE SheetId IN ('2940085806098308', '8075134644473732');

Retrieve all comments from a specific discussion in the sheet.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308' AND DiscussionId = '8206230771525508'

Retrieve a specific comment in the sheet.

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

INSERT

You can insert a comment to a discussion by providing the SheetId, DiscussionId and Text columns.
INSERT INTO Info_Comments (SheetId, DiscussionId, Text) VALUES ('568679927703428', '4661021235275652', 'This is a comment 3')

UPDATE

You can update the text of a comment in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.
UPDATE Info_Comments SET Text = 'My Comment.' WHERE SheetId = '2736916857677700' AND Id = '3641651486822276'

DELETE

You can delete a comment in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.
DELETE FROM Info_Comments WHERE SheetId = '2736916857677700' AND Id = '3641651486822276'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A unique identifier assigned to each comment, ensuring it can be referenced distinctly.

Text String False

The main content of the comment, containing the user's input or feedback.

UserName String True

The name of the user who authored the comment, useful for identifying contributors.

UserEmail String True

The email address of the user who authored the comment, allowing for communication or verification.

CreatedAt Datetime True

The timestamp indicating when the comment was originally created.

ModifiedAt Datetime True

The timestamp indicating the most recent update or edit made to the comment.

AttachmentsAggregate String True

A serialized array of attachment objects associated with the comment, providing access to related files.

DiscussionId String False

The unique identifier of the discussion thread to which the comment belongs.

SheetId String False

The unique identifier of the sheet where the comment is located.

Smartsheet Connector for CData Sync

Info_Discussions

Read and write discussions data on your Smartsheet sheets.

Table-specific Information

SELECT

This table returns a list of discussions. The SheetId column is always required.

Retrieve all discussions in a sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308'

Retrieve all discussions in a specific row of a sheet.

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

Retrieve details of a specified discussion.

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

INSERT

You can insert a discussion into a sheet by providing the SheetId and FirstDiscussionComment columns. To add a discussion to a row in the sheet instead, provide the RowId, SheetId, and FirstDiscussionComment columns. Refer to the following query examples:
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')

DELETE

You can delete a discussion in the sheet by specifying the SheetId and Id columns in the criteria as shown in the following example query:
DELETE FROM Info_Discussions WHERE SheetId = '8449165781585796' AND Id = '5354407478988676'

Columns

Name Type ReadOnly References Description
Id [KEY] String False

A unique identifier for the discussion within the Smartsheet.

Title String False

The subject or headline of the discussion, providing a brief summary of its content.

AccessLevel String False

Indicates the user's permission level for accessing the discussion (for example, view, edit).

ParentId String False

The unique identifier of the row or sheet directly associated with the discussion.

ParentType String False

Specifies whether the discussion is linked to a row or a sheet. Possible values include: SHEET or ROW.

LastCommentedAt Datetime False

The timestamp indicating when the most recent comment was added to the discussion.

LastCommentBy String False

The full name of the user who made the latest comment in the discussion.

CreatorName String False

The full name of the user who initiated the discussion.

ReadOnly Boolean False

Indicates if the discussion is in a read-only state, preventing any modifications.

SheetId String False

The unique identifier of the sheet where the discussion is located.

RowId String False

The unique identifier of the row associated with the discussion.

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.

Name Type Description
FirstDiscussionComment String

A special input-only field for adding the initial comment to a new discussion.

Smartsheet Connector for CData Sync

Info_Folders

Read and write folders data in your Smartsheet account.

Table-specific Information

The RootFolderId pseudo-column and the CreatedAt, ModifiedAt columns are NOT present when UseLegacyAPI is enabled.

SELECT

Retrieve all folders.
SELECT * FROM Info_Folders

Retrieve details for a specific folder.

SELECT * FROM Info_Folders WHERE Id = '2035256120371076'

Retrieve all folders in a specific workspace.

SELECT * FROM Info_Folders WHERE WorkspaceId = '2940085806098308'

Retrieve all folders which are located beneath the folder specified in the folder hierarchy. Only simple criteria like the ones below can be processed for this pseudo-column, otherwise the condition will just be ignored:

SELECT * FROM Info_Folders WHERE RootFolderId = '993868452784004';
SELECT * FROM Info_Folders WHERE RootFolderId = '993868452784004' AND Name = 'MyFolder';

INSERT

You can create a folder inside a workspace or a parent folder by providing either the WorkspaceId column or the ParentFolderId column, and the Name column as shown in the example queries below.
INSERT INTO Info_Folders (WorkspaceId, Name) VALUES ('609757951223684', 'My Folder 1')
INSERT INTO Info_Folders (ParentFolderId, Name) VALUES ('5465554459879300', 'My Folder 1')

UPDATE

You can update folder data by specifying the Id column in the criteria as shown in the example query below.
UPDATE Info_Folders SET Name = 'My Test Folder 1' WHERE Id = '2035256120371076'

DELETE

You can delete a folder by specifying the Id column in the criteria as shown in the example query below.
DELETE FROM Info_Folders WHERE Id = '2035256120371076'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A system-generated unique identifier for the folder, used to reference it programmatically.

Name String False

The user-defined name of the folder, typically representing its content or purpose.

Permalink String True

A direct, shareable URL linking to the folder within Smartsheet, useful for quick access.

Favorite Boolean True

Indicates whether the user has marked the folder as a favorite for easier navigation in their Home tab.

WorkspaceId String False

The unique identifier of the workspace that contains this folder, useful for context within a workspace hierarchy.

ParentFolderId String False

Info_Folders.Id

The unique identifier of the parent folder where the folder is stored, indicating its organizational structure.

CreatedAt Datetime True

The time when the folder was created.

ModifiedAt Datetime True

The time when the folder was last modified.

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.

Name Type Description
RootFolderId String

The Id of the root folder in which the object resides. Can be used to query the data from only a specific folder (and its subfolders) in the Smartsheet hierarchy.

Smartsheet Connector for CData Sync

Info_Groups

Read and write groups data in your Smartsheet account.

Table-specific Information

SELECT

Retrieve all groups.
SELECT * FROM Info_Groups

Retrieve details for a specific group.

SELECT * FROM Info_Groups WHERE Id = '2035256120371076'

INSERT

You can create a group by providing the Name column as shown in the following example query:
INSERT INTO Info_Groups (Name, Description, MemberEmails) VALUES ('My Group', 'Testing Group 1.', '[email protected],[email protected]')

UPDATE

You can update group data by specifying the Id column in the criteria as shown in the following example query:
UPDATE Info_Groups SET Name = 'Testing Group 1', Description = 'My Testing Group 1.', OwnerId = '8428447480473476' WHERE Id = '2035256120371076'

DELETE

You can delete a group by specifying the Id column in the criteria as shown in the following example query:
DELETE FROM Info_Groups WHERE Id = '2035256120371076'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A unique identifier for the group, used as the primary key.

Name String False

The descriptive name of the group, typically used for display and identification.

Description String False

A brief summary or details about the purpose or function of the group.

Owner String True

The email address of the user who owns or administers the group.

OwnerId String False

The unique identifier for the user who owns or manages the group.

CreatedAt Datetime True

The timestamp indicating when the group was initially created.

ModifiedAt Datetime True

The timestamp indicating the most recent update or change made to the group.

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.

Name Type Description
MemberEmails String

A comma separated list of values containing the emails of the users to add in the group. This column is write-only and can be used only for INSERT statements.

Smartsheet Connector for CData Sync

Info_Users

Read and write users data in your Smartsheet account.

Table-specific information

SELECT

Retrieve all users.
SELECT * FROM Info_Users

Retrieve all users in a specific group.

SELECT * FROM Info_Users WHERE GroupId = '2928085806875091'

INSERT

You can create a user in your Smartsheet account by providing the Email, LicensedSheetCreator and Admin columns as shown in the example query below.
INSERT INTO Info_Users (Email, LicensedSheetCreator, Admin) VALUES ('[email protected]', true, true)

UPDATE

You can update user data by providing the Id column in the criteria as shown in the example query below.
UPDATE Info_Users SET FirstName = 'My Test', LastName = 'User 1', Admin = false, GroupAdmin = false, LicensedSheetCreator = false WHERE Id = '8307802553771908'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A unique identifier assigned to each user, used to differentiate them within the system.

AccountId String True

The unique identifier of the account to which the user belongs, establishing account association.

AccountName String True

The name of the account associated with the user, providing a human-readable reference.

Email String False

The email address registered for the user, used for communication and login purposes.

Name String True

The user's full name as it appears in the system, combining first and last name.

FirstName String False

The user's first name, typically used in personal greetings and identification.

LastName String False

The user's last name, often used for formal identification.

Admin Boolean False

Indicates whether the user is a system administrator with privileges to manage accounts and other users.

Locale String True

The language and regional settings associated with the user, impacting date formats and other locale-specific elements.

TimeZone String True

The user's timezone, used to localize date and time information across the platform.

LicensedSheetCreator Boolean False

Indicates if the user holds a license to create and own sheets within the system.

GroupAdmin Boolean False

Specifies whether the user can create and manage groups, granting them group admin privileges.

ResourceViewer Boolean False

Indicates if the user has access to view resource management features such as workload views.

Status String True

The current status of the user within the system. Possible values include: ACTIVE, PENDING, or DECLINED.

GroupId String True

The unique identifier of the group to which the user belongs, if applicable.

Company String True

The name of the company the user is associated with. Populated only when filtering by user Id.

Department String True

The department within the company that the user is part of. Populated only when filtering by user Id.

MobilePhone String True

The user's mobile phone number. This field is populated only when filtering by user Id.

LastLogin String True

The timestamp of the user's last login. Only populated if the user has logged in and an Id filter is applied.

Role String True

The role or position of the user within their organization. Populated only when filtering by user Id.

Title String True

The professional title of the user within their organization. Populated only when filtering by user Id.

WorkPhone String True

The user's work phone number. This field is populated only when filtering by user Id.

SendEmail Boolean False

Whether to send an email to the user's email address once they are created (invited in the Smartsheet account). This columns always returns null in SELECT statements, and is supposed to be used in INSERT statements only.

Smartsheet Connector for CData Sync

Info_Workspaces

Read and write workspace data in your Smartsheet account.

Table-specific Information

SELECT

Retrieve all workspaces.
SELECT * FROM Info_Workspaces

Retrieve details for a specific workspace.

SELECT * FROM Info_Workspaces WHERE Id = '2928085806875091'

INSERT

You can create a workspace by providing the Name column as shown in the example query below.
INSERT INTO Info_Workspaces (Name) VALUES ('My Workspace 1')

UPDATE

You can update workspace data by specifying the Id column in the criteria as shown in the example query below.
UPDATE Info_Workspaces SET Name = 'My Test Workspace 1' WHERE Id = '2928085806875091'

DELETE

You can delete a workspace by specifying the Id column in the criteria as shown in the example query below.
DELETE FROM Info_Workspaces WHERE Id = '2928085806875091'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A globally unique identifier (GUID) for the workspace, used to distinguish it from other workspaces.

Name String False

The user-defined name of the workspace, used for organization and identification.

Favorite Boolean True

Indicates whether the workspace has been marked as a favorite by the user for quick access.

AccessLevel String True

Specifies the permissions level assigned to the user for this workspace, such as Viewer, Editor, or Admin.

Permalink String True

A permanent URL that provides a direct link to access the workspace within Smartsheet.

Smartsheet Connector for CData Sync

Sheet_Content_Calendar

Manage and analyze the Sheet_Content_Calendar, designed for scheduling and content tracking.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

The unique identifier for a row in the sheet, used to track specific entries in the calendar.

Prio String False

Indicates the priority of the content, such as High, Medium, or Low, to assist in scheduling and resource allocation.

Image String False

References the associated image file or URL, if any, for the content being planned.

Title & Link String False

Represents the title of the content and optionally includes a hyperlink to additional details or resources.

Details String False

Provides a detailed description of the content, including key themes or objectives.

Assigned To String False

Specifies the person or team responsible for creating or managing the content.

Draft Due Datetime False

The deadline for submitting the draft version of the content, ensuring timely reviews.

Draft Status String False

Tracks the current progress of the draft, such as In Progress, Completed, or Pending Review.

Approved By String False

Records the name of the individual or group that approved the content for publication.

Objective String False

Describes the primary goal or purpose of the content, such as increasing engagement or promoting a product.

Target String False

Defines the intended audience or demographic for the content.

Media Type String False

Categorizes the content by type, such as Article, Video, or Social Media Post.

Art Required Boolean False

Indicates whether custom artwork or graphics are needed for the content.

Placement String False

Specifies where the content will be published or distributed, such as a website, social media, or print.

Publication Date Datetime False

The planned date for the content to go live or be released to the public.

Keywords String False

Lists relevant keywords for search optimization or content categorization.

Live Boolean False

Indicates whether the content has been published and is currently live.

Smartsheet Connector for CData Sync

Sheet_Customer_Order_Tracking_History

Track and analyze historical customer order data using the Sheet_Customer_Order_Tracking_History.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

A unique identifier for each row in the order tracking history, corresponding to the API field for record identification.

PO String False

The purchase order number associated with the customer order, retrieved from the API.

PO Date Datetime False

The date when the purchase order was created, as specified in the API data.

Ship Date Datetime False

The date the order was shipped, sourced from the API field tracking shipment details.

Shipped Via String False

The shipping carrier or method used for the order, as recorded in the API.

Invoice Amount String False

The total amount billed on the invoice for the order, provided by the API.

Invoice Number String False

The unique identifier for the invoice related to the order, matching the API data.

Inv Date Datetime False

The date the invoice was generated for the order, as recorded in the API.

Terms String False

The payment terms agreed upon for the invoice, as defined in the API.

Paid Boolean False

Indicates whether the invoice has been fully paid (true) or not (false), based on API data.

Date Paid Datetime False

The date when the invoice payment was completed, if applicable, from the API.

Payment String False

Details about the payment method or transaction used for settling the invoice, as sourced from the API.

Check # String False

The check number associated with the payment, if a check was used, as recorded in the API.

Smartsheet Connector for CData Sync

Sheet_Event_Plan_Budget

Plan, budget, and track event-related data with the Sheet_Event_Plan_Budget table.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

A unique identifier for each row, used to distinguish individual entries within the table.

Task Name String False

The name or title of the task associated with this event plan, providing a clear descriptor of its purpose.

Assigned String False

The individual or team responsible for completing the task, used to track accountability.

Status String False

The current state of the task, such as 'Not Started,' 'In Progress,' or 'Completed.'

Progress String False

A visual or numerical representation of how much of the task has been completed.

$ Each String False

This column is dynamic and maps to the corresponding field in the API.

Qty String False

The quantity of items or resources required for the task, essential for accurate budgeting.

Budget String False

The allocated budget for the task, used to monitor financial planning.

Actual String False

The actual amount spent on the task, allowing for budget versus actual comparisons.

Comments String False

Additional notes or details about the task, providing context or clarification.

Smartsheet Connector for CData Sync

Sheet_Expense_Report

Manage and analyze expense reports effectively using the Sheet_Expense_Report table.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

The unique identifier for each row in the expense report sheet. Corresponds to the Row ID in the Smartsheet API.

Date Datetime False

The date associated with the expense entry, formatted as a datetime value.

Description String False

A brief description or note about the expense, such as its purpose or details.

Expense Category String False

The category to which the expense belongs, such as Travel, Meals, or Office Supplies.

Amount String False

The monetary value of the expense, stored as a string for API consistency.

Manager Approved Boolean False

Indicates whether the manager has approved this expense (true or false).

Comment String False

Additional comments or notes about the expense provided by the user or manager.

Smartsheet Connector for CData Sync

Sheet_Gantt_Project_with_Hard_Deadline

Track and manage projects with fixed deadlines using a Gantt-style layout in this Smartsheet table.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

A unique identifier for each row, used to reference the specific task or item in the API.

At Risk Boolean False

Indicates whether the task is at risk of missing its deadline or completion target.

Task Name String False

The name or title of the task, used for identifying and tracking work items.

Start Date Datetime False

The planned start date and time for the task, critical for scheduling and dependencies.

End Date Datetime False

The planned end date and time for the task, representing its deadline or completion target.

Assigned To String False

The name or unique identifier of the person or team assigned to complete the task.

Status String False

The current status of the task (for example, Not Started, In Progress, Completed).

Duration String False

The total time allocated for the task, typically measured in days or hours.

% Complete String False

The percentage of the task that has been completed, useful for tracking progress.

Predecessors String False

Specifies tasks that must be completed before this task can start, helping to define dependencies.

Comments String False

Additional notes or information about the task, often used for collaboration or clarification.

Smartsheet Connector for CData Sync

Sheet_Job_Candidate_Tracker

Track and manage job candidate progress and information with the Sheet_Job_Candidate_Tracker table.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

The unique identifier for each row in the tracker, corresponding to a specific candidate record in the API.

Candidate Name String False

The full name of the candidate being tracked in the hiring process.

Next Steps String False

Details the upcoming actions or decisions required for the candidate, such as scheduling an interview or extending an offer.

Comments String False

Contains notes or remarks from hiring managers or interviewers about the candidate.

Status String False

Indicates the current stage of the candidate in the hiring process, such as 'Applied', 'Interviewed', or 'Hired'.

RYG String False

Represents a red-yellow-green status indicator to visually track candidate progress or priority.

Start Date Datetime False

The proposed or confirmed start date for the candidate, if hired.

Hiring Mgr String False

The name of the hiring manager responsible for the candidate's recruitment process.

Referral Source String False

Indicates how the candidate was sourced, such as 'Referral', 'Job Board', or 'Career Fair'.

Hire Type String False

Specifies the type of hire, such as 'Full-Time', 'Part-Time', 'Contractor', or 'Intern'.

Compensation String False

Details the offered or agreed compensation package for the candidate, including salary or hourly rate.

Smartsheet Connector for CData Sync

Sheet_Sales_Activity_Tracking_by_Rep_Month

Monitor sales activity by representative and month with the Sheet_Sales_Activity_Tracking_by_Rep_Month table.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

The unique identifier for each row, dynamically mapped to the corresponding field in the API.

Monthly Metric String False

The specific sales metric tracked for the month, dynamically linked to the API field.

Quota String False

The assigned sales target or goal for the month, pulled dynamically from the API.

Actual String False

The actual sales performance achieved for the month, as recorded in the API.

Percent to Goal String False

The percentage of the quota achieved for the month, dynamically calculated and mapped via the API.

Variance String False

The difference between the actual sales and the quota, indicating overachievement or shortfall.

Pace String False

The rate of progress toward meeting the monthly sales goal, dynamically updated via the API.

Smartsheet Connector for CData Sync

Sheet_Simple_Sales_Pipeline

Simplify sales tracking using the Sheet_Simple_Sales_Pipeline table for streamlined data management.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

The unique identifier for each row, corresponding to the unique field in the API.

Status String False

Represents the current state of the opportunity, such as Open, Closed, or In Progress.

Company Logo String False

Stores the URL or file reference to the company's logo associated with the opportunity.

Opportunity String False

The name or identifier of the sales opportunity being tracked.

Contact Name String False

Full name of the primary contact person for the opportunity.

Sales Stage String False

Indicates the current stage in the sales pipeline, such as Qualification, Proposal, or Negotiation.

Forecast Amount String False

The projected revenue amount for the opportunity.

Probability String False

Percentage likelihood that the opportunity will be successfully closed.

Weighted Forecast String False

Calculated value of Forecast Amount multiplied by the Probability, representing the weighted revenue.

Expected Close Date Datetime False

The date by which the opportunity is expected to close.

Sales Rep String False

The name of the sales representative responsible for the opportunity.

Next Step String False

Describes the next action or task planned to progress the opportunity.

Smartsheet Connector for CData Sync

Sheet_Team_Objectives_Tracker

Monitor and track team objectives efficiently using the Sheet_Team_Objectives_Tracker.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

A unique identifier for each row, corresponding to the Row ID field in the Smartsheet API.

Task Name String False

The name or title of the task, used to identify objectives being tracked in the sheet.

Responsible String False

The individual or team assigned responsibility for completing the task.

State String False

The current status of the task, such as 'Not Started,' 'In Progress,' or 'Completed.'

Due Date Datetime False

The deadline for the task, represented as a date and time, used for scheduling and tracking purposes.

Comments String False

Additional notes or comments related to the task, providing context or updates for collaborators.

Smartsheet Connector for CData Sync

Sheet_Team_Task_List_by_Priority

Prioritize and manage team tasks with the Sheet_Team_Task_List_by_Priority table.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

The unique identifier for each row in the task list, dynamically mapped to the corresponding field in the API.

RYG String False

Indicates the red-yellow-green (RYG) priority or status flag for a task, dynamically mapped to the corresponding field in the API.

Task String False

The title or name of the task, dynamically mapped to the corresponding field in the API.

Assigned To String False

The name or unique identifier of the individual or team responsible for the task, dynamically mapped to the corresponding field in the API.

Reviewed Boolean False

A flag indicating whether the task has been reviewed, dynamically mapped to the corresponding field in the API.

Status String False

The current status of the task (for example, In Progress, Completed), dynamically mapped to the corresponding field in the API.

Due Datetime False

The due date and time for the task, dynamically mapped to the corresponding field in the API.

Notes & Comments String False

Additional notes or comments related to the task, dynamically mapped to the corresponding field in the API.

Smartsheet Connector for CData Sync

Sheet_WebFormTest

Test and analyze web form data integration using the Sheet_WebFormTest table.

Columns

Name Type ReadOnly References Description
RowId [KEY] String False

A unique identifier for each row, typically used to reference and track specific entries in the web form.

Form Field 1 String False

Represents the first field in the web form, typically used to collect user input or specific details.

Form Field 2 String False

Represents the second field in the web form, used to capture additional user-provided information.

Form Date Field Datetime False

Stores the date and time associated with the web form submission, providing a timestamp for tracking and analysis.

Smartsheet Connector for CData Sync

Views

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.

Smartsheet Connector for CData Sync Views

Name Description
Info_AttachmentVersions Read data on the versions of the attachments in your Smartsheet sheets.
Info_CellHistory Query the available CellHistory of a Cell in Smartsheet.
Info_Cells Query Smartsheet Cells. A collection of Cells comprises each Row in a Sheet.
Info_Contacts Query Smartsheet Contacts. A Contact is the personal contact of a User in Smartsheet.
Info_DashboardPublishSettings Provides the publish status details of Smartsheet dashboards
Info_Dashboards Query Smartsheet Dashboards.
Info_DashboardShares Query the Sharing operations of Dashboards.
Info_Favorites Query Smartsheet Favorites.
Info_Home Query objects on the Home tab in Smartsheet. The Home tab shows all objects a User has access to.
Info_ReportPublishSettings Provides publish settings for Smartsheet reports.
Info_Reports Query Smartsheet Reports.
Info_ReportShares Query the Sharing operations of Reports.
Info_Rows Query Rows in a Sheet or Report. Each Row is composed of a collection of Cells, and may optionally contain Discussions and Attachments.
Info_ServerInformation Query Smartsheet Server Information including application constants.
Info_SheetPublishSettings Provides publish settings for Smartsheet sheets.
Info_Sheets Query Smartsheet 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.
Info_SheetShares Query the Sharing operations of Sheets.
Info_Templates Query Smartsheet Templates.
Info_WorkspaceShares Query the Sharing operations of Workspaces.

Smartsheet Connector for CData Sync

Info_AttachmentVersions

Read data on the versions of the attachments in your Smartsheet sheets.

Table-specific information

SELECT

Retrieve all attachment versions of an attachment in the sheet.
SELECT * FROM Info_AttachmentVersions WHERE SheetId = '8449165781585796' AND AttachmentId = '2879526696423300'

Columns

Name Type References Description
Id [KEY] String The unique identifier of the attachment version.
SheetId String The unique identifier of the sheet in which the attachment is located.
AttachmentId String The unique identifier of the attachment (Id of the most recent version).
Name String The name of the attachment.
MimeType String The attachment MIME type (e.g. 'PNG').
CreatedAt Timestamp The time when the attachment was created.
ParentId String The unique identifier of the object to which the attachment belongs to.
ParentType String The type of object to which the attachment belongs to.

The allowed values are SHEET, ROW, COMMENT.

UserName String The full name of the user who created the attachment.
UserEmail String The email address of the user who created the attachment.
URL String The temporary URL of the attachment.
SizeInKB Long The size of the attachment in kilobytes.
Description String The description of the attachment.

Smartsheet Connector for CData Sync

Info_CellHistory

Access the historical changes of specific cells in Smartsheet, enabling detailed audit and tracking capabilities.

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

Name Type References Description
Value String The most recent content in the cell, which could include text, numbers, or the result of a formula. This value represents the cell's current state.
ModifiedAt Datetime The date and time when the cell was last updated. This helps in identifying the most recent activity in the cell.
EditorName String The full name of the user who made the latest changes to the cell. This provides clarity about who is responsible for updates.
EditorEmail String The email address of the user who last modified the cell, allowing for easy communication or audit purposes.
SheetId String A unique identifier for the sheet containing this cell. This links the cell to its corresponding sheet in Smartsheet.
RowId String A unique identifier for the row in which this cell is located. This helps in pinpointing and managing specific rows.
ColumnId String A unique identifier for this cell's column enables efficient column-based operations or analysis.

Smartsheet Connector for CData Sync

Info_Cells

Explore individual cell data in Smartsheet rows, offering granular insights into sheet contents.

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

Name Type References Description
Id [KEY] String The unique identifier of the column that contains the cell. This is a reference to the parent column in the sheet's schema.
Value String The actual content of the cell, which can be a string, number, or boolean, representing the cell's primary data.
DisplayValue String The formatted version of the cell's content as displayed to the user in the Smartsheet UI, reflecting applied formats and rules.
ColumnType String The type of data or content allowed in the column (for example, text, date, dropdown) as defined in the column's schema.
Formula String The formula applied to the cell, if any, used to compute dynamic values based on other cell references.
Format String Descriptor specifying the visual formatting of the cell, such as text style, color, or alignment.
ConditionalFormat String The formatting applied to the cell based on conditional rules set at the column or sheet level.
Strict Boolean Indicates if strict parsing rules are applied to the cell's value. Defaults to true; set to false for more lenient value handling.
SheetId String The unique identifier of the sheet to which this cell belongs.
RowId String The unique identifier of the row containing this cell, representing its position in the sheet.

Smartsheet Connector for CData Sync

Info_Contacts

Query Smartsheet user contact details, facilitating management of personal and shared connections.

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

Name Type References Description
Id [KEY] String A unique identifier assigned to each contact, used to differentiate them within the database.
Name String The full name of the contact, typically including both first and last names.
Email String The primary email address associated with the contact, used for communication purposes.

Smartsheet Connector for CData Sync

Info_DashboardPublishSettings

Provides the publish status details of Smartsheet dashboards

Columns

Name Type References Description
DashboardId [KEY] String The unique identifier of the dashboard whose publish status is being retrieved.
ReadOnlyFullEnabled Boolean Indicates whether the 'Read-Only Full' version of the dashboard is published, allowing viewers to interact with widgets and use shortcuts.
ReadOnlyFullUrl String The URL for accessing the 'Read-Only Full' view of the published dashboard. Only returned if 'ReadOnlyFullEnabled' is true.
ReadOnlyFullAccessibleBy String Specifies who can access the 'Read-Only Full' view of the published dashboard. Possible values: ALL (anyone with the link), ORG (members of the owner's organization), SHARED (users shared to the item).

Smartsheet Connector for CData Sync

Info_Dashboards

Query Smartsheet Dashboards.

Columns

Name Type References Description
Id [KEY] String The unique identifier of the Dashboard.
Name String The name of the Dashboard.
AccessLevel String The access level for the user or group on the shared object.
Permalink String URL that represents a direct link to the Dashboard in Smartsheet.
CreatedAt Datetime Time that the share was created.
ModifiedAt Datetime Time that the share was modified.
WorkspaceId String Id of workspace where this Dashboard is located
FolderId String The Id of the folder.

Smartsheet Connector for CData Sync

Info_DashboardShares

Query the Sharing operations of Dashboards.

Columns

Name Type References Description
Id [KEY] String The unique identifier of this share.
DashboardId [KEY] String The Id of the Dashboard.
Type String The type of this share. Possible values: USER or GROUP.
UserId String The user Id for a user share.
GroupId String The group Id of a group share.
Email String The email address for a user share.
Name String The full name for a user share where the user is also a contact. The group name for a group share.
AccessLevel String The access level for the user or group on the shared object.
Scope String The scope of the share (ITEM or WORKSPACE).
CreatedAt Datetime Time that the share was created.
ModifiedAt Datetime Time that the share was modified.

Smartsheet Connector for CData Sync

Info_Favorites

Retrieve a user's favorite items in Smartsheet, helping prioritize frequently accessed content.

Table Specific Information

Select

This view returns a list of Favorite objects.

Retrieve all Favorite objects.

SELECT * FROM Info_Favorites

Columns

Name Type References Description
ObjectId String A unique identifier for the item that has been marked as a favorite. For favorite items of the type 'template,' only private sheet-type template IDs are permitted.
Type String Specifies the category of the favorite item. Possible values include 'workspace' for a collection of sheets and reports, 'folder' for a grouping of related items, 'sheet' for individual sheets, 'report' for consolidated data views, and 'template' for reusable sheet designs.

Smartsheet Connector for CData Sync

Info_Home

Access items available on the Smartsheet Home tab, offering a centralized view of user-permissible objects.

Table Specific Information

This view is present in the data model only when UseLegacyAPI is enabled.

Select

Retrieve all objects located on the Home tab:

SELECT * FROM Info_Home

Columns

Name Type References Description
SheetsAggregate String An array containing details about all sheet objects associated with the home information.
FoldersAggregat String An array containing details about all folder objects within the current context of the home environment.
ReportsAggregat String An array containing details about all report objects, providing insights into shared or owned reports in the home scope.
TemplatesAggregat String An array containing details about all template objects available within the home context, used for creating new sheets.
WorkspacesAggregat String An array containing details about all workspace objects, representing collaborative spaces within the home environment.

Smartsheet Connector for CData Sync

Info_ReportPublishSettings

Provides publish settings for Smartsheet reports.

Columns

Name Type References Description
ReportId [KEY] String Unique identifier of the report whose publish settings are being retrieved.
ReadOnlyFullEnabled Boolean Indicates whether the report is published in a rich, read-only format with features like downloading attachments and discussions.
ReadOnlyFullUrl String URL for accessing the 'Read-Only Full' view of the published report; available only if ReadOnlyFullEnabled is true.
ReadOnlyFullAccessibleBy String Specifies who can access the 'Read-Only Full' view: ALL (anyone with the link), ORG (members of the report owner's organization), or SHARED (users shared to the item); returned only if ReadOnlyFullEnabled is true.
ReadOnlyFullDefaultView String Indicates the default view for the 'Read-Only Full' published report: CALENDAR, CARD, or GRID.

Smartsheet Connector for CData Sync

Info_Reports

Query Smartsheet reports, providing insights into custom aggregated data across sheets.

Table Specific Information

The RootFolderId pseudo-column is NOT present when UseLegacyAPI is enabled.

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'

Retrieve Reports which are located beneath the folder specified in the folder hierarchy. Only simple criteria like the ones below can be processed for this pseudo-column, otherwise the condition will just be ignored:

SELECT * FROM Info_Reports WHERE RootFolderId = '993868452784004';
SELECT * FROM Info_Reports WHERE RootFolderId = '993868452784004' AND Name = 'MyReport';

Columns

Name Type References Description
Id [KEY] String A unique identifier for the report, used as the primary key for reference.
Name String The descriptive name of the report, typically used to identify its purpose or content.
FolderId String The unique identifier of the folder where the report is stored, indicating its organizational structure.
WorkspaceId String The unique identifier of the workspace containing this report, representing its broader context and ownership.
Permalink String URL that represents a direct link to the report in Smartsheet.

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.

Name Type Description
RootFolderId String The Id of the root folder in which the object resides. Can be used to query the data from only a specific folder (and its subfolders) in the Smartsheet hierarchy.

Smartsheet Connector for CData Sync

Info_ReportShares

Query the Sharing operations of Reports.

Columns

Name Type References Description
Id [KEY] String The unique identifier of this share.
ReportId [KEY] String The Id of the report.
Type String The type of this share. Possible values: USER or GROUP.
UserId String The user Id for a user share.
GroupId String The group Id of a group share.
Email String The email address for a user share.
Name String The full name for a user share where the user is also a contact. The group name for a group share.
AccessLevel String The access level for the user or group on the shared object.
Scope String The scope of the share (ITEM or WORKSPACE).
CreatedAt Datetime Time that the share was created.
ModifiedAt Datetime Time that the share was modified.

Smartsheet Connector for CData Sync

Info_Rows

Retrieve detailed row data, including cells, discussions, and attachments, for enhanced row-level analysis.

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

Name Type References Description
Id [KEY] String A unique identifier for the row, assigned by Smartsheet. This value is guaranteed to be unique within the sheet.
RowNumber Integer The sequential number of the row within the sheet, starting at 1. Useful for referencing rows in a user-friendly way.
Version Integer Indicates the current version of the sheet. This number increments each time a modification is made to the sheet.
FilteredOut Boolean Indicates if this row is excluded from view by an applied column filter. True means the row is hidden; False means it is visible.
InCriticalPath Boolean True if this row is part of the critical path in a project sheet with dependencies enabled. Useful for project planning and scheduling.
Locked Boolean Indicates if the row has been locked by the sheet owner or admin to prevent changes.
LockedForUser Boolean Indicates if the row is locked for the current user based on their permissions.
Expanded Boolean Shows whether the row is currently expanded to reveal child rows or collapsed to hide them.
AccessLevel String Defines the user's access permissions to the sheet containing this row (for example, Viewer, Editor, Admin).
Format String Describes the visual format applied to the row, such as font color, background color, and text styles.
ConditionalFormat String Specifies the visual format applied to the row due to a conditional formatting rule.
CreatedAt Datetime The timestamp when the row was initially created in Smartsheet.
ModifiedAt Datetime The timestamp when the row was last modified. Helps track changes over time.
Permalink String A permanent URL linking directly to this row in Smartsheet for easy access.
ParentId String The unique identifier of the parent row, if this row is part of a hierarchical structure.
SiblingId String The unique identifier of the previous sibling row at the same hierarchical level. Useful for determining row order.
ToTop Boolean A flag indicating if the row should be moved or inserted at the top of the sheet.
ToBottom Boolean A flag indicating if the row should be moved or inserted at the bottom of the sheet.
Above Boolean A flag indicating if the row should be moved or inserted above another specified row.
SheetId String The unique identifier of the sheet to which this row belongs.

Smartsheet Connector for CData Sync

Info_ServerInformation

Access Smartsheet server information and application constants, useful for API integrations.

Table Specific Information

Select

Retrieve Server Information:

SELECT * FROM Info_ServerInformation

Columns

Name Type References Description
SupportedLocales String An array of locale strings supported by Smartsheet, used for regional and language settings.
FormatsDefaults String Describes default format settings for display in the Smartsheet Web application when no custom format values are applied.
FontFamily String Defines the font families available, including additional metadata about each font.
FontSize String Specifies font sizes in points, representing the height of characters in text.
Bold String Indicates if text is bolded. Possible values include 'none' (not bolded) and 'on' (bolded).
Italic String Indicates if text is italicized. Possible values include 'none' (not italicized) and 'on' (italicized).
Underline String Indicates if text is underlined. Possible values include 'none' (no underline) and 'on' (underlined).
Strikethrough String Indicates if text has a strikethrough effect. Possible values include 'none' (no strikethrough) and 'on' (strikethrough applied).
HorizontalAlign String Defines horizontal text alignment within cells. Possible values include 'none', 'left', 'center', 'right'.
VerticalAlign String Defines vertical text alignment within cells. Possible values include 'top', 'middle', 'bottom'. The default value is 'top'.
Color String Specifies text and background color in hex format. If 'none', applications use default colors (for example, Black for text, White for background).
Currency String Lists supported currency codes (for example, USD, EUR) along with their respective symbols.
ThousandsSeparator String Determines if numbers display a thousands separator (for example, 1,000). Possible values include 'none' (no separator) and 'on' (separator applied).
NumberFormat String Specifies how numbers are formatted. Possible values include 'none', 'NUMBER', 'CURRENCY', 'PERCENT'.
TextWrap String Indicates whether text wraps within the cell. Possible values include 'none' (no wrap) and 'on' (text wraps).

Smartsheet Connector for CData Sync

Info_SheetPublishSettings

Provides publish settings for Smartsheet sheets.

Columns

Name Type References Description
SheetId [KEY] String Unique identifier of the Smartsheet sheet.
ReadOnlyFullEnabled Boolean Indicates if the 'Read-Only Full' view, with attachments and discussions, is published.
ReadOnlyFullUrl String URL for the 'Read-Only Full' view; available if ReadOnlyFullEnabled is true.
ReadOnlyFullAccessibleBy String Specifies who can access the 'Read-Only Full' view: ALL (anyone with the link), ORG (organization members), or SHARED (shared users); available if ReadOnlyFullEnabled is true.
ReadOnlyFullDefaultView String Default view mode for 'Read-Only Full' view: CALENDAR, CARD, or GRID.
ReadOnlyLiteEnabled Boolean Indicates if a lightweight 'Read-Only Lite' view, without attachments and discussions, is published.
ReadOnlyLiteUrl String URL for the 'Read-Only Lite' HTML view; available if ReadOnlyLiteEnabled is true.
ReadOnlyLiteSslUrl String SSL URL for the 'Read-Only Lite' view.
ReadWriteEnabled Boolean Indicates if the 'Edit by Anyone' view, with editing capabilities, is published.
ReadWriteUrl String URL for the 'Edit by Anyone' view; available if ReadWriteEnabled is true.
ReadWriteAccessibleBy String Specifies who can access the 'Edit by Anyone' view: ALL (anyone with the link), ORG (organization members), or SHARED (shared users); available if ReadWriteEnabled is true.
ReadWriteDefaultView String Default view mode for 'Edit by Anyone' view: CALENDAR, CARD, or GRID.
IcalEnabled Boolean Indicates if an iCal feed is available for the sheet's calendar.
IcalUrl String URL for the iCal feed of the sheet's calendar; available if IcalEnabled is true.

Smartsheet Connector for CData Sync

Info_Sheets

Explore detailed metadata and structure of Smartsheet sheets, including their components like columns, rows, and attachments.

Table Specific Information

The RootFolderId pseudo-column is NOT present when UseLegacyAPI is enabled.

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'

Retrieve Sheets which are located beneath the folder specified in the folder hierarchy. Only simple criteria like the ones below can be processed for this pseudo-column, otherwise the condition will just be ignored:

SELECT * FROM Info_Sheets WHERE RootFolderId = '993868452784004';
SELECT * FROM Info_Sheets WHERE RootFolderId = '993868452784004' AND Name = 'MySheet';

Columns

Name Type References Description
Id [KEY] String A unique identifier assigned to the sheet, used for referencing it programmatically or in APIs.
Name String The descriptive name of the sheet, visible to users in the Smartsheet interface.
Owner String The email address of the user who owns the sheet and has primary control over its permissions and content.
OwnerId String The unique identifier of the user who owns the sheet, used for internal user management.
Permalink String A permanent, shareable URL that provides direct access to the sheet in Smartsheet.
SourceId String The unique identifier of the original sheet or template from which this sheet was created, useful for tracing its origin.
SourceType String Indicates whether the source object for this sheet was a 'sheet' or a 'template', helping to categorize its origin.
CreatedAt Datetime The timestamp indicating when the sheet was first created in Smartsheet.
ModifiedAt Datetime The timestamp of the most recent modification made to the sheet's content or properties.
Version Long A revision number incremented with each change made to the sheet, useful for tracking updates.
TotalRowCount Long The total number of rows currently present in the sheet, reflecting its data capacity or usage. Values for this column are retrieved only when filtering with the Id column.
AccessLevel String The permission level of the current user for this sheet, such as 'viewer', 'editor', or 'admin'.
ReadOnly Boolean Indicates if the sheet is in read-only mode, typically due to an expired trial or restricted permissions.
GanttEnabled Boolean Specifies whether the Gantt chart feature is enabled for this sheet, allowing project timelines to be visualized.
DependenciesEnabled Boolean Shows if dependency tracking is active, used for managing task relationships and schedules.
ResourceManagementEnabled Boolean Indicates if resource management tools are enabled, supporting workload and capacity planning.
Favorite Boolean Indicates whether the user has marked this sheet as a favorite, making it easier to locate in their Home tab.
ShowParentRowsForFilters Boolean Specifies if the 'Show Parent Rows' option is enabled for filtering, helping to display hierarchical context.
FromId String The unique identifier of the template from which the sheet was originally created, used for template-based organization.
WorkspaceId String The unique identifier of the workspace where the sheet is stored, aiding in categorization and collaboration.
FolderId String The unique identifier of the folder containing the sheet, for better organization within Smartsheet.

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.

Name Type Description
RootFolderId String The Id of the root folder in which the object resides. Can be used to query the data from only a specific folder (and its subfolders) in the Smartsheet hierarchy.

Smartsheet Connector for CData Sync

Info_SheetShares

Query the Sharing operations of Sheets.

Columns

Name Type References Description
Id [KEY] String The unique identifier of this share.
SheetId [KEY] String The Id of the sheet.
Type String The type of this share. Possible values: USER or GROUP.
UserId String The user Id for a user share.
GroupId String The group Id of a group share.
Email String The email address for a user share.
Name String The full name for a user share where the user is also a contact. The group name for a group share.
AccessLevel String The access level for the user or group on the shared object.
Scope String The scope of the share (ITEM or WORKSPACE).
CreatedAt Datetime Time that the share was created.
ModifiedAt Datetime Time that the share was modified.

Smartsheet Connector for CData Sync

Info_Templates

Retrieve Smartsheet template information to streamline the creation of standardized sheets.

Table Specific Information

The RootFolderId pseudo-column is NOT present when UseLegacyAPI is enabled.

Select

By default this view returns all Templates created by the user. If the Scope 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 Scope = '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'

Retrieve Templates which are located beneath the folder specified in the folder hierarchy. Only simple criteria like the ones below can be processed for this pseudo-column, otherwise the condition will just be ignored:

SELECT * FROM Info_Templates WHERE RootFolderId = '993868452784004';
SELECT * FROM Info_Templates WHERE RootFolderId = '993868452784004' AND Name = 'MyTemplate';

Columns

Name Type References Description
Id [KEY] String A unique identifier assigned to each template, ensuring it can be distinctly referenced.
Name String The user-defined name of the template, used for display and identification purposes.
Description String A detailed overview or summary of the template's purpose and contents.
AccessLevel String Defines the level of user permissions on the template, such as 'read-only' or 'editor'.
Permalink String A permanent, unique URL linking directly to the template for easy sharing or access.
Scope String The scope of the template. Possible values: 'public' for templates accessible to all users, and 'user' for templates created and accessible only by the logged-in user.

The allowed values are public, user.

FolderId String The unique identifier of the folder where the template is stored, helping to organize templates.
WorkspaceId String The unique identifier of the workspace containing the template, useful for multi-user collaboration.
TemplateType String Type of template. Only applicable to public templates. Possible values: 'report', 'sheet'.
Categories String Indicates whether the template is blank. Only applicable to public templates.
Tags String List of search tags for this template. Only applicable to non-blank public templates.
Locale String Indicates the language and region settings for the template, such as 'en-US' or 'fr-FR'.
Blank Boolean Indicates whether the template is blank. Only applicable to public templates.
GlobalTemplate String Type of global template. Only applicable to blank public templates. Possible values: 'BLANK_SHEET', 'PROJECT_SHEET', 'TASK_LIST'.
Image String The URL pointing to an image representing the template, often used in visual displays or previews.
LargeImage String URL to the large preview image for this template. Only applicable to non-blank public templates.

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.

Name Type Description
RootFolderId String The Id of the root folder in which the object resides. Can be used to query the data from only a specific folder (and its subfolders) in the Smartsheet hierarchy.

Smartsheet Connector for CData Sync

Info_WorkspaceShares

Query the Sharing operations of Workspaces.

Columns

Name Type References Description
Id [KEY] String The unique identifier of this share.
WorkspaceId [KEY] String The Id of the workspace.
Type String The type of this share. Possible values: USER or GROUP.
UserId String The user Id for a user share.
GroupId String The group Id of a group share.
Email String The email address for a user share.
Name String The full name for a user share where the user is also a contact. The group name for a group share.
AccessLevel String The access level for the user or group on the shared object.
Scope String The scope of the share (ITEM or WORKSPACE).
CreatedAt Datetime Time that the share was created.
ModifiedAt Datetime Time that the share was modified.

Smartsheet Connector for CData Sync

Report_Sales_Activity_And_Team_Objectives

Analyze sales activities and team objectives using a dedicated Smartsheet report for performance tracking.

Columns

Name Type References Description
Sheet Name String The name of the sheet representing sales activity and team objectives, providing a top-level identifier for the report.
Primary String The primary column, typically used as a key identifier or main reference point for each row in the sales activity and objectives table.
Responsible String Indicates the individual or team responsible for the associated sales activity or objective, helping to assign accountability.
Pace String Represents the pace at which sales activities are progressing, helping track velocity against goals.
Percent to Goal String Shows the percentage completion towards the specified sales goals, aiding in performance tracking.
Due Date Datetime The target completion date for the sales activity or objective, allowing for effective time management and planning.
Actual String Records the actual performance or results achieved in the sales activity, enabling comparison with the target goals.
Quota String Specifies the target or quota assigned for the sales activity, serving as a benchmark for performance evaluation.
Comments String Provides additional notes or remarks related to the sales activity or objectives, offering context or insights for each entry.
State String Denotes the current status or condition of the sales activity, such as 'In Progress,' 'Completed,' or 'Pending.'

Smartsheet Connector for CData Sync

Report_Tasks_and_Events

Access detailed task and event data within a Smartsheet report for efficient planning and monitoring.

Columns

Name Type References Description
RowId [KEY] String A unique identifier for each row in the sheet, corresponding to the RowId field in the Smartsheet API.
Sheet Name String The name of the sheet this row belongs to, as retrieved from the Smartsheet API.
Primary String The primary column for the sheet, used to identify the key attribute of each row.
Assigned To String The individual or team responsible for the task or event, as designated in the sheet.
Comments String Additional notes or comments provided for the task or event.
Status String The current status of the task or event, such as 'In Progress,' 'Completed,' or 'Not Started.'
Due Datetime The due date and time for the task or event, formatted as a datetime object.
Due Date Datetime The specific due date for the task or event without the time component.
Budget String The budget associated with the task or event, often used for financial tracking.
Assigned String The person or entity to whom the task or event is currently assigned.
Actual String The actual cost, time, or resource allocation for the task or event.
Notes & Comments String Detailed notes and comments related to the task or event, providing additional context.
Reviewed Boolean A boolean flag indicating whether the task or event has been reviewed (true or false).
Progress String A textual or percentage-based indication of the task's progress, such as '50%' or 'Halfway Complete.'

Smartsheet Connector for CData Sync

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Smartsheet.

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

Smartsheet Connector for CData Sync Stored Procedures

Name Description
CopyRowsToAnotherSheet Copies rows from one Smartsheet to another, streamlining data reorganization.
CopySheet Duplicates an existing sheet and relocates it to a specified folder, home directory, or workspace.
CreateSheet Creates a new sheet in Smartsheet for data organization and tracking.
DeleteAttachment Deletes an attachment located in one of your Smartsheet sheets.
DeleteDashboardShare Deletes a dashboard share in your Smartsheet account.
DeleteReportShare Deletes a report share in your Smartsheet account.
DeleteSheet Deletes a specific sheet from Smartsheet to manage space and relevance.
DeleteSheetShare Deletes a sheet share in your Smartsheet account.
DeleteUser Deletes a user in your Smartsheet account.
DeleteWorkspaceShare Deletes a workspace share in your Smartsheet account.
ImportFile Imports CSV or XLSX files into Smartsheet, specifying the target folder or workspace.
MoveRowsToAnotherSheet Moves rows between Smartsheets for efficient data organization and management.
MoveSheet Relocates a sheet to a new folder, home directory, or workspace for better accessibility.
ShareDashboard Shares a dashboard with a user or group in your Smartsheet account.
ShareReport Shares a report with a user or group in your Smartsheet account.
ShareSheet Shares a sheet with a user or group in your Smartsheet account.
ShareWorkspace Shares a workspace with a user or group in your Smartsheet account.
UpdateDashboardShare Updates a dashboard share in your Smartsheet account.
UpdateReportShare Updates a report share in your Smartsheet account.
UpdateSheetShare Updates a sheet share in your Smartsheet account.
UpdateWorkspaceShare Updates a workspace share in your Smartsheet account.

Smartsheet Connector for CData Sync

CopyRowsToAnotherSheet

Copies rows from one Smartsheet to another, streamlining data reorganization.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC CopyRowsToAnotherSheet SheetId='31687716431748', RowIds='2022727655155588,6526327282526084', DestinationSheetId='1622612322346884'

Input

Name Type Required Description
SheetId String False The unique identifier of the source sheet from which rows will be copied.
RowIds String False A comma-separated list of row IDs to copy from the source sheet. Required unless 'RowIdsFilePath' is provided.
RowIdsFilePath String False The full file path to a local text file containing a comma-separated list of row IDs to be copied. Use this if 'RowIds' is not directly specified.
DestinationSheetId String False The unique identifier of the destination sheet where rows will be copied.
Include String False Optional. Specifies additional row elements to copy beyond cell data. Can include 'attachments', 'discussions', 'children', or 'all' to copy all elements.
IgnoreRowsNotFound String False Optional parameter. Specifies whether to ignore missing row IDs in the source sheet. The option 'true' skips errors for missing IDs, while 'false' (the default) causes the operation to fail if any row IDs are not found.

Result Set Columns

Name Type Description
Success String Indicates whether the operation to copy rows completed successfully (true or false).
AffectedRows String The total number of rows successfully copied to the destination sheet.

Smartsheet Connector for CData Sync

CopySheet

Duplicates an existing sheet and relocates it to a specified folder, home directory, or workspace.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC CopySheet SheetId='632130486200196', DestinationId='7513635955206020', DestinationType='folder', NewName='CopiedSheet'

Input

Name Type Required Description
SheetId String False The unique identifier of the source sheet to be copied. This is a required parameter for initiating the copy operation.
DestinationType String False Specifies the type of container where the sheet will be copied. Accepted values are 'folder' (for folders), 'home' (for personal space), or 'workspace' (for shared workspaces).
DestinationId String False The unique identifier of the destination container. This is required if 'DestinationType' is 'folder' or 'workspace' but must be null when 'DestinationType' is 'home'.
NewName String False The desired name for the newly created copy of the sheet. This attribute is applicable for copy operations only and is ignored for move operations.
Include String False A comma-separated list of additional sheet elements to include in the copy operation. Options include 'attachments' (file attachments), 'cellLinks' (cross-sheet references), 'data' (includes cell data and formatting), 'discussions' (comments), 'filters', 'forms', 'ruleRecipients' (notification recipients must include 'rules'), 'rules' (workflow rules), 'shares' (shared user access). Note that the Cell history cannot be copied.
Exclude String False Optional parameter. Use 'sheetHyperlinks' to exclude hyperlinks in the copied sheet.

Result Set Columns

Name Type Description
Success String Indicates whether the sheet copy operation completed successfully. Returns 'true' for success and 'false' for failure.

Smartsheet Connector for CData Sync

CreateSchema

Generates schema files for specified tables or views for documentation or integration purposes.

CreateSchema

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

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

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

Input

Name Type Required Description
TableName String True Specifies the name of the target table or view for which the schema will be generated. This input determines the scope of the schema creation.
FileName String False The absolute file path, including the file name, where the generated schema will be saved. Example: 'C:\\Users\\User\\Desktop\\SmartSheet\\sheet.rsd'. If left empty, FileStream is required.

Result Set Columns

Name Type Description
Result String Indicates the success or failure of the schema generation process. Returns 'Success' for successful execution or 'Failure' for errors.
FileData String Provides the schema file data encoded in Base64 format if neither FileName nor FileStream is specified as input.

Smartsheet Connector for CData Sync

CreateSheet

Creates a new sheet in Smartsheet for data organization and tracking.

Stored Procedure-Specific Information

This procedure uses indexed parameters. Indexed parameters let you provide multiple values for the same input by adding #1, #2, #3, and so forth, to the parameter name.

To execute this procedure, you must specify the ColumnName#, ColumnType#, and PrimaryColumn# input parameters for each column added. For example:

EXEC CreateSheet SheetName = 'TestSheet', ColumnName#1 = 'Id', ColumnType#1 = 'TEXT_NUMBER', PrimaryColumn#1 = true, ColumnName#2 = 'Column1', ColumnType#2 = 'TEXT_NUMBER', PrimaryColumn#2 = false
In the Input table below, indexed parameters are denoted with a '#' character at the end of their names.

Input

Name Type Required Description
SheetName String True The name of the new sheet to be created. This should be a unique, user-friendly identifier for the sheet.
ColumnName# String False The name of the column to be added to the sheet. Use descriptive names for clarity.
ColumnType# String False The data type of the column values, such as TEXT_NUMBER or CHECKBOX, which defines how the column data is stored and validated.
PrimaryColumn# String False Specifies whether this column is the primary column, which typically serves as the main identifier for rows in the sheet. Set this value to 'true' for the primary column, 'false' otherwise.

Result Set Columns

Name Type Description
Success String A boolean or status flag indicating if the sheet creation operation was successful.
Id String The unique identifier of the sheet created.

Smartsheet Connector for CData Sync

DeleteAttachment

Deletes an attachment located in one of your Smartsheet sheets.

Stored Procedure-Specific Information

Executing this procedure can have different effects, based on the values specified in the procedure parameters:

  • If the value specified in the AttachmentId parameter corresponds to the identifier of a specific version of the attachment, then only that version is deleted.
  • If the value specified in the AttachmentId parameter corresponds to the identifier of the attachment and that attachment has only 1 version, then the attachment is deleted completely.
  • If the value specified in the AttachmentId parameter corresponds to the identifier of the attachment and the DeleteAllVersions parameter is set to true, then the attachment is deleted completely.

To execute this procedure, enter:

EXEC DeleteAttachment SheetId='8449165781585796', AttachmentId='8812618818817924'

Input

Name Type Required Description
SheetId String True The unique identifier of the sheet containing the attachment to be deleted.
AttachmentId String True The unique identifier of the attachment or attachment version to be deleted.
DeleteAllVersions Boolean False Boolean value indicating whether to delete all versions of the attachment, which would delete the attachment itself completely as well.

Result Set Columns

Name Type Description
Success Boolean Boolean value indicating whether the deletion operation was successful. Returns 'true' if the attachment (or version) was deleted, and 'false' otherwise.

Smartsheet Connector for CData Sync

DeleteDashboardShare

Deletes a dashboard share in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC DeleteDashboardShare DashboardId='3559165791482796', ShareId='AAAd8aDaFOeE'

Input

Name Type Required Description
DashboardId String True The unique identifier of the dashboard which was shared.
ShareId String True The unique identifier of the dashboard share.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the dashboard share was deleted successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

DeleteReportShare

Deletes a report share in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC DeleteReportShare ReportId='8284296482606980', ShareId='AAAd8aDaFOeE'

Input

Name Type Required Description
ReportId String True The unique identifier of the report which was shared.
ShareId String True The unique identifier of the report share.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the report share was deleted successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

DeleteSheet

Deletes a specific sheet from Smartsheet to manage space and relevance.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC DeleteSheet SheetName='MySheet'

Input

Name Type Required Description
SheetId String False The unique identifier of the sheet to be deleted. This is typically a numeric or GUID value that uniquely identifies a sheet in Smartsheet.
SheetName String False The name of the sheet to be deleted. This should match the name of an existing sheet, providing a human-readable reference.

Result Set Columns

Name Type Description
Success String Indicates whether the deletion operation was successful. Returns 'true' for success or 'false' if the operation failed.

Smartsheet Connector for CData Sync

DeleteSheetShare

Deletes a sheet share in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC DeleteSheetShare SheetId='8449165781585796', ShareId='AAAd8aDaFOeE'

Input

Name Type Required Description
SheetId String True The unique identifier of the sheet which was shared.
ShareId String True The unique identifier of the sheet share.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the sheet share was deleted successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

DeleteUser

Deletes a user in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC DeleteUser UserId='8428447480473476', RemoveFromSharing='true', TransferOwnership='true', TransferTo='4417793262151556'

Input

Name Type Required Description
UserId String True The unique identifier of the user to be deleted.
RemoveFromSharing Boolean False Boolean value indicating whether to remove the user's access to all assets created by them in your account.
TransferOwnership Boolean False Boolean value indicating whether to transfer ownership of all the deleted user's assets to another user. By default, the ownership is transferred to the group owner of each group the deleted user was part of.
TransferTo String False The unique identifier of the user to which the assets of the deleted user will be transferred to. Applies only when 'TransferOwnership' is set to true. Use this parameter to override the default behavior of 'TransferOwnership'.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the user was deleted, and 'false' otherwise.

Smartsheet Connector for CData Sync

DeleteWorkspaceShare

Deletes a workspace share in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC DeleteWorkspaceShare WorkspaceId='526966953666436', ShareId='AAAd8aDaFOeE'

Input

Name Type Required Description
WorkspaceId String True The unique identifier of the workspace which was shared.
ShareId String True The unique identifier of the workspace share.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the workspace share was deleted successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

DownloadAttachment

Downloads attachments directly from Smartsheet for offline access.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC DownloadAttachment SheetId='3309422198974340', AttachmentId='7882794210748292', Location='C:/Downloads/', FileName='my_attachment.txt'

Input

Name Type Required Description
SheetID String True The unique identifier of the sheet from which the attachment will be downloaded. Required for locating the desired attachment.
AttachmentID String True A unique identifier assigned to the attachment to be downloaded. This ensures the correct file is retrieved.
Location String False The file system path where the downloaded attachment will be saved. Leave empty to use FileStream instead.
FileName String False An optional new name for the downloaded file. If not provided, the original attachment name will be used.
Override String False Determines whether an existing file with the same name at the specified Location should be overwritten. If set to false, a unique name will be generated for the downloaded file.

The default value is true.

Result Set Columns

Name Type Description
Success String Indicates whether the attachment download operation was successful (True) or encountered an error (False).
URL String A temporary URL that provides access to download the attachment directly. Note: The URL expires in 120 seconds (2 minutes).
Content String The Base64-encoded data of the downloaded file, returned when neither Location nor FileStream is provided. Useful for in-memory processing.

Smartsheet Connector for CData Sync

GetOAuthAccessToken

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

Stored Procedure Specific Information

To execute this stored procedure, you must specify at least the OAuthClientId and OAuthClientSecret connection properties.

Additionally, you should also make sure the CallbackURL connection property or the 'CallbackUrl' input parameter matches with the 'App redirect URL' configured in your OAuth App Profile.

Input

Name Type Required Description
AuthMode String False Specifies the type of authentication flow to use. Choose 'App' for a desktop-based authentication flow via a Windows forms app, or 'Web' for a browser-based flow via a web app.

The allowed values are APP, WEB.

The default value is APP.

Scope String False Defines the specific permissions or access levels your application is requesting from Smartsheet. Examples include read-only access or full administrative access.
CallbackUrl String False The URL to which the user will be redirected after authorizing your application. This must exactly match the Redirect URL specified in your Smartsheet app settings. Required only when 'AuthMode' is set to 'Web'.
Verifier String False A unique code provided by Smartsheet after the user authorizes your app. This value is included as a parameter in the callback URL to confirm the authorization.
State String False A unique string generated by your application to maintain state between the authorization request and callback. Helps protect against cross-site request forgery (CSRF) attacks.

Result Set Columns

Name Type Description
OAuthAccessToken String The OAuth Access Token issued by Smartsheet for authenticated API calls. Use this token to access resources on behalf of the user.
OAuthRefreshToken String The OAuth Refresh Token issued by Smartsheet, which can be used to obtain a new access token without requiring user interaction.
ExpiresIn String The duration, in seconds, before the access token expires and needs to be refreshed using the refresh token.

Smartsheet Connector for CData Sync

GetOAuthAuthorizationURL

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

To execute this stored procedure, you must specify at least the OAuthClientId connection property.

Additionally, you should also make sure the CallbackURL connection property or the 'CallbackUrl' input parameter matches with the 'App redirect URL' configured in your OAuth App Profile.

Input

Name Type Required Description
CallbackUrl String False The URL to which Smartsheet will redirect the user after they authorize your application. It must match the callback URL registered with your app.
Scope String False The specific permissions or actions that the app is requesting access to within the Smartsheet account, such as reading sheets or managing users.
State String False A unique value that maintains state between the request and callback. It can be used for request validation or to prevent cross-site request forgery (CSRF) attacks.

Result Set Columns

Name Type Description
URL String The authorization URL that the user must visit to grant the requested permissions and obtain an authorization code or verifier token for further API interactions.

Smartsheet Connector for CData Sync

ImportFile

Imports CSV or XLSX files into Smartsheet, specifying the target folder or workspace.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC ImportFile SheetName='MySheet', HeaderRowIndex='0', PrimaryColumnIndex='0', FileName='C:/Files/my_data.csv'

Input

Name Type Required Description
SheetName String True Required. Specifies the name of the new sheet to be created in Smartsheet. This will appear as the title of the sheet.
HeaderRowIndex String False Optional parameter. A zero-based integer that identifies the row to use as column headers in the imported file. Rows before this index are ignored during the import. If omitted, columns are assigned default names such as Column1, Column2, etc.
PrimaryColumnIndex String False Optional parameter. A zero-based integer indicating which column to set as the primary column in the new sheet. The primary column is used for unique identifiers and critical data. Defaults to 0 if not specified.
FileName String True Specifies the name and extension of the file to upload, including the optional full file path if the Content parameter is not used. For example: 'C:/Users/Public/Desktop/Departments.csv'.
FolderId String False Specifies the folder where the new sheet will be created. If provided, the imported data is saved into a new sheet within this folder.
WorkspaceId String False Specifies the workspace where the new sheet will be created. If provided, the imported data is saved into a new sheet within this workspace.
Overwrite String False Indicates whether to overwrite an existing sheet with the same name. If true, FolderId or WorkspaceId is required and the existing sheet will be replaced with the new data.

The default value is false.

Result Set Columns

Name Type Description
Id String The unique identifier of the newly created or updated sheet.
Name String The name of the newly created or updated sheet as it appears in Smartsheet.
AccessLevel String The access level of the current user on the new sheet, such as 'Viewer', 'Editor', or 'Admin'.
Permalink String The direct URL link to access the newly created or updated sheet in Smartsheet.
Success String Indicates whether the deletion operation was successful. Returns 'true' for success or 'false' if the operation failed.

Smartsheet Connector for CData Sync

MoveRowsToAnotherSheet

Moves rows between Smartsheets for efficient data organization and management.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC MoveRowsToAnotherSheet SheetId='8310941453444996', RowIds='4785499724638084,2533699910952836,844850050688900', DestinationSheetId='3774818974754692'

Input

Name Type Required Description
SheetId String False The unique identifier of the source sheet from which rows will be moved.
RowIds String False A list of row IDs to move, provided as comma-separated values. This is required unless RowIdsFilePath is specified.
RowIdsFilePath String False The absolute path to a local text file containing a comma-separated list of row IDs to be moved. This is required unless RowIds is specified.
DestinationSheetId String False The unique identifier of the destination sheet where rows will be moved to.
Include String False An optional, comma-separated list specifying additional elements to move along with the rows, such as attachments or discussions.
IgnoreRowsNotFound String False Optional parameter. Set to 'True' to ignore errors for rows not found in the source sheet. The default is 'False', causing an error if non-existent rows are specified.

Result Set Columns

Name Type Description
Success String Indicates whether the rows were moved successfully (True or False).
AffectedRows String The total number of rows that were successfully moved.

Smartsheet Connector for CData Sync

MoveSheet

Relocates a sheet to a new folder, home directory, or workspace for better accessibility.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC MoveSheet SheetId='632130486200196', DestinationId='5002803811772292', DestinationType='folder'

Input

Name Type Required Description
SheetId String True The unique identifier of the sheet to be relocated within Smartsheet.
DestinationType String True Specifies the target container type for the sheet relocation. Valid values include 'folder', 'home', or 'workspace'.
DestinationId String False The unique identifier of the target container for the sheet relocation. Mandatory if 'DestinationType' is 'folder' or 'workspace'. If 'DestinationType' is 'home', this value must be null.

Result Set Columns

Name Type Description
Success String Indicates if the sheet was successfully moved to the specified destination (True or False).

Smartsheet Connector for CData Sync

RefreshOAuthAccessToken

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

Stored Procedure Specific Information

To execute this stored procedure, you must specify at least the OAuthClientId and OAuthClientSecret connection properties.

Input

Name Type Required Description
OAuthRefreshToken String True The refresh token issued during the last authentication cycle, required to request a new access token.

Result Set Columns

Name Type Description
OAuthAccessToken String The newly generated OAuth Access Token from Smartsheet, enabling authenticated requests to the service's API.
OAuthRefreshToken String A newly issued OAuth Refresh Token that can be used to renew the access token after its expiration.
ExpiresIn String The number of seconds remaining until the access token expires and needs renewal.

Smartsheet Connector for CData Sync

ShareDashboard

Shares a dashboard with a user or group in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC ShareDashboard DashboardId='3559165791482796', UserEmail='[email protected]', AccessLevel='EDITOR', SendEmail='true', CcMe='true', EmailSubject='Sharing this dashboard with you', EmailMessage='You can find the shared dashboard below.'

Input

Name Type Required Description
DashboardId String True The unique identifier of the dashboard being shared.
UserEmail String False The email of the user to share the dashboard with.
GroupId String False The unique identifier of the group to share the dashboard with.
AccessLevel String True The access level for the user or group on the shared dashboard.

The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

SendEmail Boolean False Boolean value indicating whether to notify the user or group about the shared dashboard with an email.
CcMe Boolean False Boolean value indicating whether to send a copy of the email to the sharer of the dashboard. Applies only when 'SendEmail' is set to true.
EmailSubject String False The subject of the email for the shared dashboard. Applies only when 'SendEmail' is set to true.
EmailMessage String False The message of the email for the shared dashboard. Applies only when 'SendEmail' is set to true.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the dashboard was shared successfully, and 'false' otherwise.
Id String The unique identifier of the created dashboard share.

Smartsheet Connector for CData Sync

ShareReport

Shares a report with a user or group in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC ShareReport ReportId='8284296482606980', UserEmail='[email protected]', AccessLevel='EDITOR', SendEmail='true', CcMe='true', EmailSubject='Sharing this report with you', EmailMessage='You can find the shared report below.'

Input

Name Type Required Description
ReportId String True The unique identifier of the report being shared.
UserEmail String False The email of the user to share the report with.
GroupId String False The unique identifier of the group to share the report with.
AccessLevel String True The access level for the user or group on the shared report.

The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

SendEmail Boolean False Boolean value indicating whether to notify the user or group about the shared report with an email.
CcMe Boolean False Boolean value indicating whether to send a copy of the email to the sharer of the report. Applies only when 'SendEmail' is set to true.
EmailSubject String False The subject of the email for the shared report. Applies only when 'SendEmail' is set to true.
EmailMessage String False The message of the email for the shared report. Applies only when 'SendEmail' is set to true.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the report was shared successfully, and 'false' otherwise.
Id String The unique identifier of the created report share.

Smartsheet Connector for CData Sync

ShareSheet

Shares a sheet with a user or group in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC ShareSheet SheetId='8449165781585796', UserEmail='[email protected]', AccessLevel='EDITOR', SendEmail='true', CcMe='true', EmailSubject='Sharing this sheet with you', EmailMessage='You can find the shared sheet below.'

Input

Name Type Required Description
SheetId String True The unique identifier of the sheet being shared.
UserEmail String False The email of the user to share the sheet with.
GroupId String False The unique identifier of the group to share the sheet with.
AccessLevel String True The access level for the user or group on the shared sheet.

The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

SendEmail Boolean False Boolean value indicating whether to notify the user or group about the shared sheet with an email.
CcMe Boolean False Boolean value indicating whether to send a copy of the email to the sharer of the sheet. Applies only when 'SendEmail' is set to true.
EmailSubject String False The subject of the email for the shared sheet. Applies only when 'SendEmail' is set to true.
EmailMessage String False The message of the email for the shared sheet. Applies only when 'SendEmail' is set to true.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the sheet was shared successfully, and 'false' otherwise.
Id String The unique identifier of the created sheet share.

Smartsheet Connector for CData Sync

ShareWorkspace

Shares a workspace with a user or group in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC ShareWorkspace WorkspaceId='526966953666436', UserEmail='[email protected]', AccessLevel='EDITOR', SendEmail='true', CcMe='true', EmailSubject='Sharing this workspace with you', EmailMessage='You can find the shared workspace below.'

Input

Name Type Required Description
WorkspaceId String True The unique identifier of the workspace being shared.
UserEmail String False The email of the user to share the workspace with.
GroupId String False The unique identifier of the group to share the workspace with.
AccessLevel String True The access level for the user or group on the shared workspace.

The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

SendEmail Boolean False Boolean value indicating whether to notify the user or group about the shared workspace with an email.
CcMe Boolean False Boolean value indicating whether to send a copy of the email to the sharer of the workspace. Applies only when 'SendEmail' is set to true.
EmailSubject String False The subject of the email for the shared workspace. Applies only when 'SendEmail' is set to true.
EmailMessage String False The message of the email for the shared workspace. Applies only when 'SendEmail' is set to true.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the workspace was shared successfully, and 'false' otherwise.
Id String The unique identifier of the created workspace share.

Smartsheet Connector for CData Sync

UpdateDashboardShare

Updates a dashboard share in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC UpdateDashboardShare DashboardId='3559165791482796', ShareId='AAAd8aDaFOeE', AccessLevel='ADMIN'

Input

Name Type Required Description
DashboardId String True The unique identifier of the dashboard which was shared.
ShareId String True The unique identifier of the dashboard share.
AccessLevel String True The access level for the user or group on the shared dashboard.

The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the dashboard share was updated successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

UpdateReportShare

Updates a report share in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC UpdateReportShare ReportId='8284296482606980', ShareId='AAAd8aDaFOeE', AccessLevel='ADMIN'

Input

Name Type Required Description
ReportId String True The unique identifier of the report which was shared.
ShareId String True The unique identifier of the report share.
AccessLevel String True The access level for the user or group on the shared report.

The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the report share was updated successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

UpdateSheetShare

Updates a sheet share in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC UpdateSheetShare SheetId='8449165781585796', ShareId='AAAd8aDaFOeE', AccessLevel='ADMIN'

Input

Name Type Required Description
SheetId String True The unique identifier of the sheet which was shared.
ShareId String True The unique identifier of the sheet share.
AccessLevel String True The access level for the user or group on the shared sheet.

The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the sheet share was updated successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

UpdateWorkspaceShare

Updates a workspace share in your Smartsheet account.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC UpdateWorkspaceShare WorkspaceId='526966953666436', ShareId='AAAd8aDaFOeE', AccessLevel='ADMIN'

Input

Name Type Required Description
WorkspaceId String True The unique identifier of the workspace which was shared.
ShareId String True The unique identifier of the workspace share.
AccessLevel String True The access level for the user or group on the shared workspace.

The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

Result Set Columns

Name Type Description
Success Boolean A boolean value indicating whether the operation was successful. Returns 'true' if the workspace share was updated successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

UploadAttachment

Uploads a file attachment in one of your Smartsheet sheets.

Stored Procedure-Specific Information

To execute this procedure, enter:
EXEC UploadAttachment SheetId='5613673485651844', Name='my_attachment.jpg', FilePath='C:/Files/my_attachment.jpg'

Input

Name Type Required Description
SheetId String True The unique identifier of the sheet where the file attachment will be uploaded. Omitting both CommentId and RowId parameters, will result in the attachment being uploaded in sheet level.
RowId String False The unique identifier of a row in the sheet, if you want to attach the file in row level.
CommentId String False The unique identifier of a comment in the sheet, if you want to attach the file in comment level.
Name String True The name of the attachment.
FilePath String False The absolute path of the file in your system to upload as the new attachment.

Result Set Columns

Name Type Description
Success Boolean Boolean value indicating whether the upload operation was successful. Returns 'true' if the new attachment was created successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

UploadAttachmentVersion

Uploads a new attachment version to a file attachment in one of your Smartsheet sheets.

Stored Procedure-Specific Information

Use this stored procedure to re-upload a file attachment, which creates a new version of the attachment. Note that file attachments located in comment level cannot be re-uploaded.

You can also query the Info_AttachmentVersions table to read data on the versions of an attachment. However, if the attachment is not a file attachment (such as a link attachment), only one version is returned for that attachment.

To execute this procedure, enter:

EXEC UploadAttachmentVersion SheetId='8449165781585796', AttachmentId='5642314839789444', Name='my_attachment_v2.png', FilePath='C:/Files/my_attachment.jpg'

Input

Name Type Required Description
SheetId String True The unique identifier of the sheet containing the file attachment.
AttachmentId String True The unique identifier of the file attachment.
Name String True The name of the attachment in the new version.
FilePath String False The path of the file to upload as the new attachment version.

Result Set Columns

Name Type Description
Success Boolean Boolean value indicating whether the upload operation was successful. Returns 'true' if the new attachment version was created successfully, and 'false' otherwise.

Smartsheet Connector for CData Sync

Data Type Mapping

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 (when TypeDetectionScheme is set to RowScan; the default behavior).

Smartsheet CData Schema
TEXT_NUMBER (Text) string
TEXT_NUMBER (Whole Number) int (<2,147,483,647) or long (>2,147,483,647)
TEXT_NUMBER (Decimal) float
CHECKBOX bool
DATE date
DATETIME datetime
ABSTRACT_DATETIME datetime
CONTACT_LIST string
MULTI_CONTACT_LIST string
PICKLIST string
MULTI_PICKLIST string
Symbols for CHECKBOX columns bool
Symbols for PICKLIST columns string

For more information on Smartsheet data types, refer to Column Types from Smartsheet's API reference.

Smartsheet Connector for CData Sync

Connection String Options

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


PropertyDescription
AuthSchemeSpecifies the authentication method to use when connecting to Smartsheet.
PersonalAccessTokenSpecifies the Personal Access Token for authenticating with Smartsheet. This token can be generated through the Smartsheet user interface.

Connection


PropertyDescription
RegionSpecifies the hosting region for your Smartsheet account.
UseLegacyAPIDetermines what API to use for discovering tables metadata (and some columns metadata as well).

OAuth


PropertyDescription
OAuthClientIdSpecifies 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.
OAuthClientSecretSpecifies 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.).
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

SSL


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

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies 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


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

Schema


PropertyDescription
LocationSpecifies 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.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous


PropertyDescription
HeaderSpecifies whether the first row of the data is treated as column headers or not.
HideFormattingCharactersSpecifies whether to hide formatting characters, such as currency symbols and percentage signs, in numeric values. When enabled, numeric columns are converted from varchar to double.
IgnoreRowsNotFoundSpecifies whether the deletion operation should proceed if any specified Row IDs are not found.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Smartsheet.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ReportCompatibilityLevelSpecifies the level of compatibility for the returned data, determining the format and functionality provided in query results.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
TypeDetectionSchemeSpecifies the method used to determine the data types of columns, such as by scanning rows, analyzing column formats, or treating all columns as strings.
UseFullFilePathsAsTableNamesSpecifies whether table and view names corresponding to sheets and reports should include the full file path or only the file name.
UseIdAsTableNameSpecifies whether sheet and report IDs, rather than their names, are used as table identifiers.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNamesSpecifies whether or not simple names should be used for tables and columns.
ValueSourceSpecifies whether the driver retrieves cell values from the Value fields, the DisplayValue field, or automatically selects based on availability.
Smartsheet Connector for CData Sync

Authentication

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


PropertyDescription
AuthSchemeSpecifies the authentication method to use when connecting to Smartsheet.
PersonalAccessTokenSpecifies the Personal Access Token for authenticating with Smartsheet. This token can be generated through the Smartsheet user interface.
Smartsheet Connector for CData Sync

AuthScheme

Specifies the authentication method to use when connecting to Smartsheet.

Remarks

This property specifies whether to use Personal Access Token (PAT) or OAuth for authenticating with Smartsheet. When using PersonalAccessToken, ensure you have a valid token available. For OAuth, configure the necessary OAuth settings, such as OAuthClientId, OAuthClientSecret, and CallbackURL, to enable the provider to perform OAuth-based authentication. Choose the authentication method based on your access requirements and Smartsheet's supported security protocols.

Smartsheet Connector for CData Sync

PersonalAccessToken

Specifies the Personal Access Token for authenticating with Smartsheet. This token can be generated through the Smartsheet user interface.

Remarks

Ensure that the token is valid and matches the credentials required for the connection. If your token expires or becomes invalid, update this property with a new token.

This property is useful for secure and efficient authentication, particularly for automated workflows and integrations with the Smartsheet API.

Smartsheet Connector for CData Sync

Connection

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


PropertyDescription
RegionSpecifies the hosting region for your Smartsheet account.
UseLegacyAPIDetermines what API to use for discovering tables metadata (and some columns metadata as well).
Smartsheet Connector for CData Sync

Region

Specifies the hosting region for your Smartsheet account.

Remarks

This property specifies the region where your Smartsheet account is hosted to ensure that the provider connects to the appropriate Smartsheet data center. The available options are:

  • GLOBAL: Connects to the default global Smartsheet region.
  • EU: Connects to Smartsheet accounts hosted in the European Union.
  • GOV: Connects to Smartsheet accounts hosted in the U.S. Government cloud.

This property is useful for aligning your connection with compliance and performance requirements specific to your account's hosting region.

Smartsheet Connector for CData Sync

UseLegacyAPI

Determines what API to use for discovering tables metadata (and some columns metadata as well).

Remarks

Disabling this connection property will cause the driver to utilize more recent API-s instead of using the deprecated Home API for discovering metadata.

When the new API is used (property is disabled), reading some of the Info_ tables (Info_Sheets, Info_Templates, Info_Folders, etc.) is less performant in comparison to when the Home API is used. That's because the Sync App has to make an API call for every folder/subfolder in the workspaces of your Smartsheet account to read the corresponding resource/object for the table, due to the way that the new API is organized. That's significantly more API calls compared to when the Sync App utilizes the Home API for reading the data.

Additionally, the following changes apply to the data model when this property is disabled:

  • Info_Home is not included as a table in the data model.
  • A RootFolderId pseudo-column is included in the metadata of Info_Folders, Info_Templates, Info_Sheets and Info_Reports.
  • The CreatedAt and ModifiedAt columns are included in the metadata of Info_Folders.

Smartsheet Connector for CData Sync

OAuth

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


PropertyDescription
OAuthClientIdSpecifies 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.
OAuthClientSecretSpecifies 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.).
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
Smartsheet Connector for CData Sync

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.

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.

Smartsheet Connector for CData Sync

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

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

Smartsheet Connector for CData Sync

Scope

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

Smartsheet Connector for CData Sync

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Smartsheet Connector for CData Sync

SSLServerCert

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.

Smartsheet Connector for CData Sync

Firewall

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


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Smartsheet Connector for CData Sync

FirewallType

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 Smartsheet. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Smartsheet. 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 Smartsheet. 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.

Smartsheet Connector for CData Sync

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.

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.

Smartsheet Connector for CData Sync

FirewallPort

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.

Smartsheet Connector for CData Sync

FirewallUser

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.

Smartsheet Connector for CData Sync

FirewallPassword

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.

Smartsheet Connector for CData Sync

Proxy

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


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Smartsheet Connector for CData Sync

ProxyAutoDetect

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.

Smartsheet Connector for CData Sync

ProxyServer

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.

Smartsheet Connector for CData Sync

ProxyPort

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.

Smartsheet Connector for CData Sync

ProxyAuthScheme

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.

Smartsheet Connector for CData Sync

ProxyUser

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.

Smartsheet Connector for CData Sync

ProxyPassword

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.

Smartsheet Connector for CData Sync

ProxySSLType

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 :

AUTODefault 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.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe 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.

Smartsheet Connector for CData Sync

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.

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.

Smartsheet Connector for CData Sync

Logging

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


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Smartsheet Connector for CData Sync

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.

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

Smartsheet Connector for CData Sync

Schema

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


PropertyDescription
LocationSpecifies 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.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Smartsheet Connector for CData Sync

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.

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

Smartsheet Connector for CData Sync

BrowsableSchemas

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.

Smartsheet Connector for CData Sync

Tables

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.

Smartsheet Connector for CData Sync

Views

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.

Smartsheet Connector for CData Sync

Miscellaneous

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


PropertyDescription
HeaderSpecifies whether the first row of the data is treated as column headers or not.
HideFormattingCharactersSpecifies whether to hide formatting characters, such as currency symbols and percentage signs, in numeric values. When enabled, numeric columns are converted from varchar to double.
IgnoreRowsNotFoundSpecifies whether the deletion operation should proceed if any specified Row IDs are not found.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Smartsheet.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ReportCompatibilityLevelSpecifies the level of compatibility for the returned data, determining the format and functionality provided in query results.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
TypeDetectionSchemeSpecifies the method used to determine the data types of columns, such as by scanning rows, analyzing column formats, or treating all columns as strings.
UseFullFilePathsAsTableNamesSpecifies whether table and view names corresponding to sheets and reports should include the full file path or only the file name.
UseIdAsTableNameSpecifies whether sheet and report IDs, rather than their names, are used as table identifiers.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNamesSpecifies whether or not simple names should be used for tables and columns.
ValueSourceSpecifies whether the driver retrieves cell values from the Value fields, the DisplayValue field, or automatically selects based on availability.
Smartsheet Connector for CData Sync

Header

Specifies whether the first row of the data is treated as column headers or not.

Remarks

This property determines how the provider handles the first row of data when assigning column names. If set to true, the first row is used as column headers, allowing for more descriptive column names. If set to false, the provider assigns generic names, which may be less intuitive but avoids relying on the contents of the data.

When interpreting the first row as headers, certain conditions must be met. Column headers should not contain special characters, as these may cause parsing errors. Additionally, all column headers must be non-empty to ensure proper detection and assignment. While meaningful column names can simplify query writing and improve data readability, users should ensure that the first row in the dataset truly represents headers to avoid misinterpretation.

Smartsheet Connector for CData Sync

HideFormattingCharacters

Specifies whether to hide formatting characters, such as currency symbols and percentage signs, in numeric values. When enabled, numeric columns are converted from varchar to double.

Remarks

This property removes formatting characters from numeric values and converts them into a numerical data type (double). It works only when TypeDetectionScheme is set to RowScan and the first RowScanDepth rows in a column are convertible to double. If these conditions are not met, the column retains its original format as varchar.

This property is useful for users who need clean, numeric data for calculations or analysis. By standardizing numeric values into a consistent data type, it ensures compatibility with analytical tools and simplifies data processing workflows.

Smartsheet Connector for CData Sync

IgnoreRowsNotFound

Specifies whether the deletion operation should proceed if any specified Row IDs are not found.

Remarks

This property determines how the driver handles cases where specified Row IDs are not found during a deletion operation. If set to false, no rows are deleted, and a "not found" error is returned if any of the Row IDs are missing. If set to true, the operation proceeds, ignoring any missing Row IDs.

This property is useful for ensuring the integrity of delete operations, particularly when precise control over the affected rows is required. It can prevent unintended results caused by missing or incorrect Row IDs.

Smartsheet Connector for CData Sync

MaxRows

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.

Smartsheet Connector for CData Sync

Other

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

PropertyDescription
DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=TrueConverts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Smartsheet Connector for CData Sync

Pagesize

Specifies the maximum number of records per page the provider returns when requesting data from Smartsheet.

Remarks

When processing a query, instead of requesting all of the queried data at once from Smartsheet, the Sync App can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Sync App requests per page.

Depending on what entity is queried, there are additional restrictions for this property:

EntityRestrictions
Info_WorkspacesThe value must be a multiple of 100 in the 100 - 1000 range (inclusive).

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.

Smartsheet Connector for CData Sync

PseudoColumns

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:

*=*

Smartsheet Connector for CData Sync

ReportCompatibilityLevel

Specifies the level of compatibility for the returned data, determining the format and functionality provided in query results.

Remarks

This property specifies the compatibility level of returned data, allowing you to choose between legacy formats or newer, feature-rich data formats such as multi-contact or multi-picklist data. Choose a compatibility level based on your application's needs:

  • 0 (Backwards-compatible): Returns data in a legacy text format for maximum compatibility with older systems.
  • 1 (Multi-contact data): Returns multi-contact data in a format optimized for standard processing but not specifically for report tables.
  • 2 (Report-compatible multi-contact data): Returns multi-contact data in a format specifically designed for report tables.
  • 3 (Multi-picklist data): Returns data in a format that supports multi-picklist fields for advanced use cases.

To retrieve data for report tables, the compatibility level must be set to at least 2. Adjust this property based on your application’s requirements to balance compatibility with advanced functionality.

This property is useful for managing how Smartsheet data is processed and consumed. Use it to align your data retrieval with application-specific needs, such as maintaining compatibility with older systems or leveraging advanced data structures for more complex use cases.

Smartsheet Connector for CData Sync

RowScanDepth

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.

Smartsheet Connector for CData Sync

Timeout

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.

Smartsheet Connector for CData Sync

TypeDetectionScheme

Specifies the method used to determine the data types of columns, such as by scanning rows, analyzing column formats, or treating all columns as strings.

Remarks

This property defines how the driver determines column data types during query execution:

  • None: All columns are treated as strings. Column names are still scanned if the Header property is set to True.
  • RowScan: The driver scans rows to infer data types based on the data content. The number of rows scanned is determined by the RowScanDepth property.
  • ColumnFormat: Data types are determined based on the column's format in the dataset.

This property is useful for adapting the driver to different data structures or optimizing performance based on your dataset's characteristics.

If precision is critical, such as when working with mixed data types, use RowScan to ensure accurate type detection. For simpler datasets or when type consistency is not required, None can streamline processing. Use ColumnFormat when the dataset includes predefined formats for columns.

Smartsheet Connector for CData Sync

UseFullFilePathsAsTableNames

Specifies whether table and view names corresponding to sheets and reports should include the full file path or only the file name.

Remarks

This property controls the naming convention for tables and views exposed by the driver. If set to true, table and view names include the full file path, providing greater context for each dataset. For example, a table representing a sheet might be named SalesSheets_Agents_MonthlyReports_Sheet_JuneSheet. If set to false, only the file name is used in the table and view names. For example, Sheet_JuneSheet.

This property is useful when working with datasets that may contain files with similar names in different directories. Including the full file path helps to distinguish between files and provides additional clarity. However, for simpler datasets or use cases where shorter table names are preferred, setting this property to false can improve readability and simplify queries.

Smartsheet Connector for CData Sync

UseIdAsTableName

Specifies whether sheet and report IDs, rather than their names, are used as table identifiers.

Remarks

When this property is set to true, the driver uses sheet or report IDs as table identifiers instead of their names. For example, instead of referencing a table as Sheet_SheetName, you would use Sheet_SheetId, such as in the query:

SELECT * FROM Sheet_3759298161102724.

This property is useful in scenarios where sheet and report names are ambiguous, frequently changed, or not unique. Using IDs ensures consistent and reliable table references, even if file names are updated.

Note: The properties UseFullFilePathsAsTableNames and UseIdAsTableName cannot both be enabled at the same time. If both are set to true, an error occurs.

Smartsheet Connector for CData Sync

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.

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 Sheet_Test_Sheet WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

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

UserDefinedViews=C:\Path\To\UserDefinedViews.json
When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

Smartsheet Connector for CData Sync

UseSimpleNames

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

Remarks

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

Smartsheet Connector for CData Sync

ValueSource

Specifies whether the driver retrieves cell values from the Value fields, the DisplayValue field, or automatically selects based on availability.

Remarks

This property specifies how cell values are retrieved from the data, based on the selected source field:

  • When set to Auto, the driver automatically selects the field that is not empty.
  • When set to Value, the driver retrieves data specifically from the Value field.
  • When set to DisplayValue, the driver retrieves data from the DisplayValue field.

This property is useful for customizing how cell data is interpreted, particularly when working with data that includes both raw values and formatted display representations.

Smartsheet Connector for CData Sync

Third Party Copyrights

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.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539