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.

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.

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.

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

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_Shares	Retrieve sharing configurations for Smartsheet reports, sheets, and workspaces to manage access controls.
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

API limitations and requirements are documented in this section.

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"/>

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	Query Smartsheet Attachments. Attachments can exist on a Comment (i.e., within a Discussion), on a Row, or on a Sheet.
Info_Columns	Query Smartsheet Columns in a Sheet or Report.
Info_Comments	Query Smartsheet Comments in a Discussion.
Info_Discussions	Query Smartsheet Discussions. A Discussion is a collection of one or more Comments. A Discussion can exist on a Row or a Sheet.

Retrieve detailed information about Smartsheet attachments, which can be associated with comments, rows, or sheets, providing a comprehensive view of file dependencies.

Table Specific Information

Select

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

Retrieve all Attachments from all Sheets.

SELECT * FROM Info_Attachments

Retrieve all Attachments related to a Sheet.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308'

Retrieve all Attachments related to a discussion.

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

Retrieve all Attachments related to a Row.

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

Retrieve all Attachments related to a Comment.

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

Retrieve details of a specific Attachment.

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

Insert

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

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

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

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		A unique identifier assigned to each attachment for tracking and retrieval purposes.
Name	String	False		The user-assigned or system-generated name of the attachment, helping identify its content or purpose.
Url	String	False		A temporary URL that allows access to the attachment file for download or viewing.
UrlExpiresInMillis	Long	False		The lifespan, in milliseconds, of the temporary URL before it expires and becomes inaccessible.
AttachmentType	String	False		The category of the attachment, such as FILE or external integrations like GOOGLE_DRIVE, BOX_COM, or DROPBOX.
AttachmentSubType	String	False		Specifies the subtype for GOOGLE_DRIVE (for example, DOCUMENT, SPREADSHEET) or EGNYTE attachments (for example, FOLDER), providing further detail on the content format.
CreatedAt	Timestamp	False		The timestamp indicating when the attachment was first added to the system.
UserId	String	False		The unique identifier of the user who uploaded or created the attachment.
UserEmail	String	False		The email address of the user who added the attachment, used for contact or audit purposes.
UserName	String	False		The full name of the user who uploaded the attachment, displayed for reference. This is read-only.
MimeType	String	False		The file type of the attachment, expressed as a multipurpose internet mail extension (MIME) type (for example, image/png or application/pdf).
ParentType	String	False		Indicates the type of Smartsheet object the attachment is associated with, such as SHEET, ROW, or COMMENT.
ParentId	String	False		The unique identifier of the parent object (for example, sheet or row) that the attachment belongs to.
SizeInKb	Long	False		The size of the attachment file in kilobytes, applicable only for attachments of type FILE.
SheetId	String	False		The unique identifier of the sheet to which the attachment is linked.
RowId	String	False		The unique identifier of the row within a sheet where the attachment is associated.
DiscussionId	String	False		The unique identifier of the discussion thread to which the attachment is linked.
CommentId	String	False		The unique identifier of the comment in which the attachment is embedded.
FilePath	String	False		The file path on the local system used to insert the attachment into Smartsheet.
ContentEncoded	String	False		The BASE64-encoded representation of the file's content, used when uploading files.

Access comments within discussions in Smartsheet, providing insights into collaboration history.

Table Specific Information

Select

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

Retrieve all comments from a sheet.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308'

Retrieve details of a specified Comment.

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

Insert

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

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

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		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	False		The name of the user who authored the comment, useful for identifying contributors.
UserEmail	String	False		The email address of the user who authored the comment, allowing for communication or verification.
CreatedAt	Datetime	False		The timestamp indicating when the comment was originally created.
ModifiedAt	Datetime	False		The timestamp indicating the most recent update or edit made to the comment.
AttachmentsAggregate	String	False		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.

Analyze discussion threads, including comments, tied to specific rows or sheets for better communication tracking.

Table Specific Information

Select

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

Retrieve all Discussions related to a Sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308'

Retrieve Discussions related to a specific Row of a Sheet.

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

Retrieve details of a specified Comment.

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

Insert

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

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

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

Columns

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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_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_Favorites	Query Smartsheet Favorites.
Info_Folders	Query Smartsheet Folders in the Sheets Folder for the User, in another Folder, or in a Workspace.
Info_Groups	Query Smartsheet Groups.
Info_Home	Query objects on the Home tab in Smartsheet. The Home tab shows all objects a User has access to.
Info_Reports	Query Smartsheet 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_Shares	Query the Sharing operations of Reports, Sheets, and Workspaces.
Info_Sheets	Query Smartsheets Sheets. A Sheet can exist in the Sheets folder for the user (Home), in a Folder, or in a Workspace. It is comprised of Columns, Rows, and Cells, and may optionally contain Attachments and Discussions.
Info_Templates	Query Smartsheet Templates.
Info_Users	Query the Users in the organization.
Info_Workspaces	Query Smartsheet Workspaces.

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.

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.

Retrieve metadata and properties of columns in Smartsheet sheets or reports, essential for understanding sheet structures.

Table Specific Information

Select

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

Retrieve Columns.

SELECT * FROM Info_Columns WHERE SheetId = '2940085806098308'

Retrieve details of the specified Columns.

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

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier for the column, used to reference it programmatically.
Index	Integer		The numeric position of the column in the sheet, starting at 0 for the first column.
Title	String		The displayed name of the column, as shown in the Smartsheet interface.
Primary	Boolean		Indicates whether this column is the primary column, which typically contains key identifiers or names for rows.
Type	String		The functional data type of the column, such as Text_Number, Date, or Picklist, determining how data is stored and validated.
OptionsAggregate	String		A list of selectable options for the column, applicable for columns like dropdowns or picklists.
Hidden	Boolean		Indicates whether the column is hidden in the Smartsheet interface.
Symbol	String		Represents visual markers or indicators used in the column, with values varying by column type (for example, checkboxes, picklists).
ColumnType	String		Specifies the system-defined column type, such as auto-generated fields like 'created_by' or 'modified_date.'
TagsAggregate	String		Defines system tags for the column, used to indicate roles in features like Gantt charts or calendars (for example, 'gantt_duration').
Width	Integer		The pixel width used to display the column in the sheet's user interface.
Format	String		The applied formatting settings for the column, such as text alignment or date format.
FilterType	String		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		Indicates whether the column is locked, preventing edits by all users except the owner or admin.
LockedForUser	Boolean		Specifies whether the column is locked for the current user based on their permissions.
SheetId	String		The unique identifier of the sheet to which this column belongs.

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.

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.

Explore folder structures in Smartsheet, including user-level folders and workspace organization.

Table Specific Information

Select

Retrieve all Folders.

SELECT * FROM Info_Folders

Retrieve details for a Folder.

SELECT * FROM Info_Folders WHERE Id = '2035256120371076'

Retrieve Folders of a specified Workspace.

SELECT * FROM Info_Folders WHERE WorkspaceId = '2940085806098308'

Columns

Name	Type	References	Description
Id [KEY]	String		A system-generated unique identifier for the folder, used to reference it programmatically.
Name	String		The user-defined name of the folder, typically representing its content or purpose.
Permalink	String		A direct, shareable URL linking to the folder within Smartsheet, useful for quick access.
Favorite	Boolean		Indicates whether the user has marked the folder as a favorite for easier navigation in their Home tab.
WorkspaceId	String		The unique identifier of the workspace that contains this folder, useful for context within a workspace hierarchy.

Retrieve group information for enhanced user management and role-based permissions in Smartsheet.

Table Specific Information

Select

Retrieve all Groups.

SELECT * FROM Info_Groups

Retrieve details for a Group.

SELECT * FROM Info_Groups WHERE Id = '2035256120371076'

Columns

Name	Type	References	Description
Id [KEY]	String		A unique identifier for the group, used as the primary key.
Name	String		The descriptive name of the group, typically used for display and identification.
Description	String		A brief summary or details about the purpose or function of the group.
Owner	String		The email address of the user who owns or administers the group.
OwnerId	String		The unique identifier for the user who owns or manages the group.
CreatedAt	Datetime		The timestamp indicating when the group was initially created.
ModifiedAt	Datetime		The timestamp indicating the most recent update or change made to the group.

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

Table Specific Information

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.

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

Table Specific Information

Select

Retrieve all Reports.

SELECT * FROM Info_Reports

Retrieve Reports located in a specific Workspace.

SELECT * FROM Info_Reports WHERE WorkspaceId = '6773684447799172'

Retrieve Reports located in a specific Folder.

SELECT * FROM Info_Reports WHERE FolderId = '6773684447799172'

Columns

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.

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.

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

Retrieve sharing configurations for Smartsheet reports, sheets, and workspaces to manage access controls.

Table Specific Information

Select

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

Retrieve all Shares related to a Sheet.

SELECT * FROM Info_Shares WHERE SheetId = '2940085806098308'

Retrieve all Shares related to a Workspace.

SELECT * FROM Info_Shares WHERE WorkspaceId = '1630085806098114'

Retrieve details of a Share related to a specified Sheet.

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

Retrieve details of a Share related to a specified Workspace.

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

Columns

Name	Type	References	Description
Id [KEY]	String		A unique identifier assigned to this share, used to differentiate it from other shares.
Type	String		Specifies whether the share is for an individual user (USER) or a group (GROUP).
UserId	String		The unique identifier of the user associated with this share when the share type is USER.
GroupId	String		The unique identifier of the group associated with this share when the share type is GROUP.
Email	String		The email address of the user receiving the share, used for sending notifications and identifying the user.
Name	String		The full name of the user or the name of the group associated with the share. For users, this is shown if they are also a contact.
AccessLevel	String		Defines the level of access granted to the user or group, such as Viewer, Editor, or Admin, on the shared object.
Subject	String		The subject line of the optional email notification sent to inform the recipient about the share.
Message	String		The body text of the optional email notification sent to provide details or context about the share.
CcMe	Boolean		Indicates whether the sharer should receive a copy of the notification email sent to the recipient. True if enabled.
WorkspaceId	String		The unique identifier of the workspace that is shared.
SheetId	String		The unique identifier of the sheet that is shared within the workspace.

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

Table Specific Information

Select

Retrieve all Sheets.

SELECT * FROM Info_Sheets

Retrieve Sheets located in a specific Folder.

SELECT * FROM Info_Sheets WHERE FolderId = '2928085806875091'

Retrieve Sheets located in a specific Workspace.

SELECT * FROM Info_Sheets WHERE WorkspaceId = '1928085806875098'

Columns

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

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

Table Specific Information

Select

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

Retrieve all Templates.

SELECT * FROM Info_Templates

Retrieve all other public Templates.

SELECT * FROM Info_Templates WHERE TemplateType = 'public'

Retrieve Templates located on a specific folder.

SELECT * FROM Info_Templates WHERE FolderId = '2928085806875091'

Retrieve Templates located on a specific Workspace.

SELECT * FROM Info_Templates WHERE WorkspaceId = '1928085806875098'

Columns

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.
TemplateType	String		Specifies the type or category of the template, such as 'project plan' or 'budget sheet'. The allowed values are public, user.
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.
Image	String		The URL pointing to an image representing the template, often used in visual displays or previews.
Locale	String		Indicates the language and region settings for the template, such as 'en-US' or 'fr-FR'.
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.

Query user data within an organization for administrative and reporting purposes.

Table Specific Information

Select

Retrieve all Users.

SELECT * FROM Info_Users

Retrieve all Users of a specific Group.

SELECT * FROM Info_Users WHERE GroupId = '2928085806875091'

Columns

Name	Type	References	Description
Id [KEY]	String		A unique identifier assigned to each user, used to differentiate them within the system.
AccountId	String		The unique identifier of the account to which the user belongs, establishing account association.
AccountName	String		The name of the account associated with the user, providing a human-readable reference.
Email	String		The email address registered for the user, used for communication and login purposes.
Name	String		The user's full name as it appears in the system, combining first and last name.
FirstName	String		The user's first name, typically used in personal greetings and identification.
LastName	String		The user's last name, often used for formal identification.
Admin	Boolean		Indicates whether the user is a system administrator with privileges to manage accounts and other users.
Locale	String		The language and regional settings associated with the user, impacting date formats and other locale-specific elements.
TimeZone	String		The user's timezone, used to localize date and time information across the platform.
LicensedSheetCreator	Boolean		Indicates if the user holds a license to create and own sheets within the system.
GroupAdmin	Boolean		Specifies whether the user can create and manage groups, granting them group admin privileges.
ResourceViewer	Boolean		Indicates if the user has access to view resource management features such as workload views.
Status	String		The current status of the user within the system. Possible values include: ACTIVE, PENDING, or DECLINED.
GroupId	String		The unique identifier of the group to which the user belongs, if applicable.
Company	String		The name of the company the user is associated with. Populated only when filtering by user Id.
Department	String		The department within the company that the user is part of. Populated only when filtering by user Id.
MobilePhone	String		The user's mobile phone number. This field is populated only when filtering by user Id.
LastLogin	String		The timestamp of the user's last login. Only populated if the user has logged in and an Id filter is applied.
Role	String		The role or position of the user within their organization. Populated only when filtering by user Id.
Title	String		The professional title of the user within their organization. Populated only when filtering by user Id.
WorkPhone	String		The user's work phone number. This field is populated only when filtering by user Id.

Access workspace-level details, including sheets and folders, for better organizational insights.

Table Specific Information

Select

Retrieve all Workspaces.

SELECT * FROM Info_Workspaces

Retrieve all details for a specific Workspace.

SELECT * FROM Info_Workspaces WHERE Id = '2928085806875091'

Columns

Name	Type	References	Description
Id [KEY]	String		A globally unique identifier (GUID) for the workspace, used to distinguish it from other workspaces.
Name	String		The user-defined name of the workspace, used for organization and identification.
Favorite	Boolean		Indicates whether the workspace has been marked as a favorite by the user for quick access.
AccessLevel	String		Specifies the permissions level assigned to the user for this workspace, such as Viewer, Editor, or Admin.
Permalink	String		A permanent URL that provides a direct link to access the workspace within Smartsheet.

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

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

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.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

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

Authentication

---

Property	Description
AuthScheme	Specifies the authentication method to use when connecting to Smartsheet.
PersonalAccessToken	Specifies the Personal Access Token for authenticating with Smartsheet. This token can be generated through the Smartsheet user interface.

Connection

---

Property	Description
Region	Specifies the hosting region for your Smartsheet account.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

---

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

Firewall

---

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

Proxy

---

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

Logging

---

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

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

---

Property	Description
Header	Specifies whether the first row of the data is treated as column headers or not.
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.
IgnoreRowsNotFound	Specifies whether the deletion operation should proceed if any specified Row IDs are not found.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Smartsheet, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
ReportCompatibilityLevel	Specifies the level of compatibility for the returned data, determining the format and functionality provided in query results.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
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.
UseFullFilePathsAsTableNames	Specifies whether table and view names corresponding to sheets and reports should include the full file path or only the file name.
UseIdAsTableName	Specifies whether sheet and report IDs, rather than their names, are used as table identifiers.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.
ValueSource	Specifies whether the driver retrieves cell values from the Value fields, the DisplayValue field, or automatically selects based on availability.

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

---

Property	Description
AuthScheme	Specifies the authentication method to use when connecting to Smartsheet.
PersonalAccessToken	Specifies the Personal Access Token for authenticating with Smartsheet. This token can be generated through the Smartsheet user interface.

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.

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.

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

---

Property	Description
Region	Specifies the hosting region for your Smartsheet account.

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.

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

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

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

---

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

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

Remarks

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

This property can take the following forms:

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

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

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

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

---

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

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

Remarks

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

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

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

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

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to 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.

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

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

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, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

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

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• 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: Set this when 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.

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 user name of a user registered with the proxy server.
DIGEST	The user name 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.

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

The password associated with 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.

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

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

Remarks

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

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

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 that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

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

---

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

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

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

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

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

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

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

Remarks

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

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

Remarks

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

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

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

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

Remarks

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

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

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

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

---

Property	Description
Header	Specifies whether the first row of the data is treated as column headers or not.
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.
IgnoreRowsNotFound	Specifies whether the deletion operation should proceed if any specified Row IDs are not found.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Smartsheet, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
ReportCompatibilityLevel	Specifies the level of compatibility for the returned data, determining the format and functionality provided in query results.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
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.
UseFullFilePathsAsTableNames	Specifies whether table and view names corresponding to sheets and reports should include the full file path or only the file name.
UseIdAsTableName	Specifies whether sheet and report IDs, rather than their names, are used as table identifiers.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.
ValueSource	Specifies whether the driver retrieves cell values from the Value fields, the DisplayValue field, or automatically selects based on availability.

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.

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.

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.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in 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.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Specifies the maximum number of results to return from Smartsheet, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

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: "*=*"

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.

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

Remarks

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

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

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

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.

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.

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.

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

Remarks

This property 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 define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

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

Remarks

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

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

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.