This page provides a guide to Establishing a Connection to TSheets in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to TSheets

Establishing a Connection shows how to authenticate to TSheets and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from TSheets through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to TSheets by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to TSheets

TSheets supports the OAuth standard for user authentication. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

The following subsections describe how to authenticate to TSheets from three common authentication flows:

• Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping.
• Web: access to data via a shared website.
• Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in TSheets, see Connection.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token:

1. Before connecting to data for the first time, set these connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id in your application settings.
   • OAuthClientSecret: The client secret in your application settings.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
2. On subsequent data connections, set:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your application settings.
   • OAuthClientSecret: The Client Secret in your application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Creating a Custom OAuth Application

Creating a custom OAuth application enables you to generate OAuth credentials that are passed during user authentication.

Procedure

1. Log in to your TSheets Account.
2. At the left navigation pane, select Feature Add-ons > Manage Add-ons.
3. Select API Add-On.
4. Click Install.
5. Select Add a new application at bottom left. If a followup window does not display, return to the left navigation pane's Feature Add-ons area and select API.
6. Enter a short name and a meaningful description for the new application.
7. Set the Redirect URL to http://localhost:33333 (the Cloud's default) OR set a different port of your choice.
   Record this value; you will supply it as the CallbackURL.
8. Click Save. The admin tool generates the OAuth Client Id and Client Secret.
   Record these values for future use.
9. (Optional:) If you want to generate your access token now and connect with InitiateOAuth set to OFF, click Add Token at the bottom left portion of the display. This generates a token for immediate use.

You can access the custom OAuth application (referred to as the API Add-On) from the left navigation pane's Feature Add-ons section.

Customizing the SSL Configuration

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

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

Connecting Through a Firewall or Proxy

HTTP Proxies

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

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

Other Proxies

Set the following properties:

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

Overview

This section shows the available API objects and provides more information on executing SQL to TSheets APIs.

Key Features

• The Cloud models TSheets entities like documents, folders, and groups as relational views, allowing you to write SQL to query TSheets data.
• Stored procedures allow you to execute operations to TSheets
• Live connectivity to these objects means any changes to your TSheets account are immediately reflected when using the Cloud.

Views

Views describes the available views. Views are statically defined to model Timesheets, Users, Files, and more.

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

CData Cloud - TSheets Tables

Name	Description
GeoLocations	Retrieves a list of all geofence configs.
Groups	This table contains a list of all groups associated with your company.
JobcodeAssignments	Returns a list of all jobcode assignments associated with users.
JobCodes	This table contains a list of jobcodes associated with your company
Locations	Retrieves a list of all locations associated with your company.
Notifications	Retrieves a list of notifications associated with your company.
Reminders	Retrieves a list of reminders associated with your employees or company.
ScheduleEvents	Retrieves a list of schedule events associated with your employees or company.
Timesheets	This table contains a list of file objects.
Users	Retrieves a list of all users associated with your company.

Retrieves a list of all geofence configs.

Table Specific Information

Select

Query the GeoLocations table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id, UserId and GroupId fields support the '=' and IN operators.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following query is processed server side:

SELECT * FROM GeoLocations WHERE GroupId IN ('29474', '29474') AND LastModified <= '2020-01-01 00:00'

Insert

Insert can be executed by specifying the Created, UserId, Accuracy, Altitude, Latitude and Longitude columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table.

INSERT INTO Geolocations (Created, UserId, Accuracy, Altitude, Latitude, Longitude) VALUES ('2018-08-19T11:30:09-06:00', '1242515', '20.375', '0', '43.68662580', '-116.35166460')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Id of geolocation.
UserId	Int	False	User id for the user that this geolocation belongs to.
Accuracy	Double	False	Indicates the radius of accuracy around the geolocation in meters.
Altitude	Double	False	Indicates the altitude of the geolocation in meters.
Latitude	Double	False	Indicates the latitude of the geolocation in degrees.
Longitude	Double	False	Indicates the longitude of the geolocation in degrees.
Speed	Double	False	Indicates the speed of travel (meters per second) when the geolocation was recorded.
Source	String	False	Indicates how the GPS point was obtained. One of 'gps', 'wifi', or 'cell'.
DeviceIdentifier	String	False	Unique identifier (for the given client) for the device associated with this geolocation.
Created	Datetime	True	Date/time when this geolocation was created

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
LastModified	Datetime	Date/time when this geofence config was last modified.
GroupId	String	A comma-separated list of group ids. Only geolocations linked to users from these groups will be returned.

This table contains a list of all groups associated with your company.

Table Specific Information

Select

Query the Groups table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id and Name fields support the '=' and IN operators.
• ActiveStatus filter supports the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Groups WHERE Name IN ('Group 1', 'Group 2') AND LastModified > '2019-01-01 15:30'

SELECT * FROM Groups WHERE ActiveStatus = 'both'

Insert

Insert can be executed by specifying the Name column. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO Groups (Name) VALUES ('Group 1')
INSERT INTO Groups (Name, ManagerIds) VALUES ('Group 1', '300, 316')

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Groups SET Name = 'Group 1a', Active = 'false'  WHERE Id = '10055' 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	ID of this group.
Active	Boolean	False	If false, this group is considered archived.
Name	String	False	Name associated with this group
LastModified	Datetime	True	Date/time when this group was last modified
Created	Datetime	True	Date/time when this group was created
ManagerIds	String	True	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Returns a list of all jobcode assignments associated with users.

Table Specific Information

Select

Query the JobcodeAssignments table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id and UserId fields support the '=' and IN operators.
• JobcodeId, JobCodeType, JobCodeParentId fields and ActiveStatus filter all support the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM JobcodeAssignments WHERE UserId IN (1242515, 1242515)

SELECT * FROM JobcodeAssignments WHERE JobCodeParentId = 17285791

Insert

Insert can be executed by specifying the UserId and JobcodeId columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO JobcodeAssignments (UserId, JobcodeId) VALUES ('1234', '39')

Delete

Delete can be executed by specifying the Id in the WHERE Clause. For example:

DELETE FROM JobcodeAssignments WHERE Id = '41321421'

DELETE FROM JobcodeAssignments WHERE Id IN ('41321421', '41321435')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Id of jobcode assignment.
UserId	Int	False	Id of the user that this assignment pertains to.
JobcodeId	Int	False	Id of the jobcode that this assignment pertains to.
Active	Boolean	True	Whether or not this assignment is 'active'. If false, then the assignment has been deleted. true means it is in force.
LastModified	Datetime	True	Date/time when this jobcode assignment was last modified.
Created	Datetime	True	Date/time when this jobcode assignment was created

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
JobCodeType	String	Refers to the jobcode type - 'regular', 'pto', 'unpaid_break', 'paid_break', or 'all'. Defaults to 'regular'.
JobCodeParentId	Integer	When omitted, all jobcode assignments are returned regardless of jobcode parent. If specified, only assignments for jobcodes with the given jobcode parent_id are returned. To get a list of only top-level jobcode assignments, pass in a jobcode_parent_id of 0.
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

This table contains a list of jobcodes associated with your company

Table Specific Information

Select

Query the Jobcodes table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id and Name fields support the '=' and IN operators.
• Type field and ActiveStatus filter support the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Jobcodes WHERE Id IN (1242515, 1242515)

SELECT * FROM Jobcodes WHERE Type = 'unpaid_break'

Insert

Insert can be executed by specifying the Name and Type columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO Jobcodes (Name, Type) VALUES ('Group 1', 'pto')

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Jobcodes SET Name = 'Group 2', Type = 'pto'  WHERE Id = '10055' 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Id of jobcode.
ParentId	Int	False	Id of this jobcode's parent. 0 if it's top-level.
Name	String	False	Id of this jobcode's parent. 0 if it's top-level.
ShortCode	String	False	This is a shortened code or alias that is associated with the jobcode. It may only consist of letters and numbers. Must be unique for all jobcodes that share the same parent id.
Type	String	False	Indicates jobcode type. One of 'regular', 'pto', 'paid_break', or 'unpaid_break'
Billable	Boolean	False	Indicates whether this jobcode is billable or not.
BillableRate	Double	False	Dollar amount associated with this jobcode for billing purposes. Only effective if billable is true.
HasChildren	Boolean	True	If true, there are jobcodes that exist underneath this one, so this jobcode should be treated as a container or folder with children jobcodes underneath it.
AssignedToAll	Boolean	False	Indicates whether this jobcode is assigned to all employees or not.
RequiredCustomFields	String	True	Ids of customfields that should be displayed when this jobcode is selected on a timecard.
Active	Boolean	True	If true, this jobcode is active. If false, this jobcode is archived. To archive a jobcode, set this field to false. When a jobcode is archived, any children underneath the jobcode are archived as well. Note that when you archive a jobcode, any jobcode assignments or customfield dependencies are removed. To restore a jobcode, set this field to true. When a jobcode is restored, any parents of that jobcode are also restored.
LastModified	Datetime	True	Date/time when this jobcode was last modified.
Created	Datetime	True	Date/time when this jobcode was created
FilteredCustomFiledsItems	String	True	Displays which customfielditems should be displayed when this jobcode is chosen for a timesheet. Each property of the object is a customfield id with its value being an array of customfielditem id. If none, an empty string is returned.
ConnectWithQuickBooks	String	True	If true and the beta feature for two-way sync is enabled, then changes made to the jobcode are immediately shared with QBO.

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
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Retrieves a list of all locations associated with your company.

Table Specific Information

Select

Query the Locations table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id and GeoCodingStatus fields support the '=' and IN operators.
• ActiveStatus filter supports the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Locations WHERE GeoCodingStatus IN ('in_progress', 'retry')

SELECT * FROM Locations WHERE ByJobcodeAssignment = true

Insert

Insert can be executed by specifying any columns. Following is an example of how to insert into this table

INSERT INTO Locations (Address1, City, State, Country) VALUES ('CData office', 'Bangalore', 'KA', 'IN')

INSERT INTO Locations (Address1, City, State, Country, Zip) VALUES ('CData office', 'Bangalore', 'KA', 'IN', '560100')

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Locations SET Address1 = 'Microsoft' WHERE Id = '10055' 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id of location.
Address1	String	False	The first line of the location's address.
Address2	String	False	The second line of the location's address.
City	String	False	The city of the location's address.
State	String	False	The state of the location's address.
Zip	String	False	The postal code of the location's address.
Country	String	False	The country of the location's address.
FormattedAddress	String	True	Formatted address built from the objects addr1, addr2, city, state, and zip. If the location doesn't contain addr1, addr2, or city properties, the value will default what is set in the label property.
Active	Boolean	False	Whether this location is active. If false, this location is archived.
Latitude	Double	False	The latitude of the location (in signed degrees format).
Longitude	Double	False	The longitude of the location (in signed degrees format).
PlaceIdHash	String	False	The MD5 hash of the unique id for the location returned from the geocoding service.
Label	String	True	The formated name for the location. If the location was found using the geocode service the formated address will be saved in this field, otherwise it will be what the user has named the location.
Notes	String	False	Notes related to the location.
GeoCodingStatus	String	False	The geocoding status of this address. Will be one of: 'none', 'in_progress', 'retry', 'error', or 'complete'.
Created	Datetime	True	Date/time when this location was created
LastModified	Datetime	True	Date/time when this customfield was last modified.
LinkedObjects	String	False	A key/value map of all the objects linked to this location and the corresponding object ids.
GeofenceConfigId	Int	True	Id of the geofence_config associated with this location.

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
ByJobcodeAssignment	Boolean	If specified, only locations mapped to a jobcode the user is assigned to will be returned.
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Retrieves a list of notifications associated with your company.

Table Specific Information

Select

Query the Notifications table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id field supports the '=' and IN operators.
• MessageTrackingId and UserId fields support the '=' operator.
• DeliveryTime field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Notifications WHERE Id IN (94140223, 94140225) AND UserId = 37

SELECT * FROM Notifications WHERE MessageTrackingId = 'baabeb0ab03d62ce'

SELECT * FROM Notifications WHERE DeliveryTime = '2019-12-25 19:00'

Insert

Insert can be executed by specifying the Message column. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO Notifications (Message) VALUES ('Please clock Out!')

INSERT INTO Notifications (Message, UserId) VALUES ('Please clock Out!', '56329')

Delete

Delete can be executed by specifying the Id in the WHERE Clause. For example:

DELETE FROM Notifications WHERE Id = '41321421'

DELETE FROM Notifications WHERE Id IN ('41321421', '4132567')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the notification.
UserId	Integer	True	User id for the user that this notification will be sent to.
MessageTrackingId	String	True	A GUID string used for additional tracking.
Message	String	False	The message text of the notification. The maximum message length is 2000 characters.
Method	String	False	The transport method of the notification. We support 'push', 'email', and 'dashboard'.
Precheck	String	False	The precheck macro name. Supported macros are 'on_the_clock', 'off_the_clock', and 'none'.
Created	Datetime	True	Date/time when this notification was created
DeliveryTime	Datetime	False	Date/time when this notification will be delivered.

Retrieves a list of reminders associated with your employees or company.

Table Specific Information

Select

Query the Reminders table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id and UserId fields support the '=' and IN operators.
• ReminderType field and ActiveStatus filter support the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Reminders WHERE Id IN (72595, 72599) AND UserId = 37

SELECT * FROM Reminders WHERE ReminderType = 'clock-in'

Insert

Insert can be executed by specifying UserId, ReminderType, DueTime, DueDaysOfWeek, DistributionMethods, Active and Enabled columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO Reminders (UserId, ReminderType, DueTime, DueDaysOfWeek, DistributionMethods, Active, Enabled) VALUES ('37', 'clock-in', '08:10:00', 'Mon, Tue, Sat', 'Push', 'true', 'true')

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Reminders SET DueTime = '08:10:00', DistributionMethods = 'Email'  WHERE Id = '10055' 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the reminder.
UserId	Integer	True	User id for the user that this reminder pertains to. 0 indicates that this is a company-wide reminder.
ReminderType	String	True	The type of this reminder object. Supported reminder_types are 'clock-in' and 'clock-out'.
DueTime	String	False	The 24-hour time that the reminder should be sent, expressed as 'hh:mm:ss'.
DueDaysOfWeek	String	False	A comma-separated list of the days of the week when the reminder should be sent. The value can be any combination of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri' and 'Sat'.
DistributionMethods	String	False	The message text of the notification. The maximum message length is 2000 characters.
Active	Boolean	False	If true, this reminder is active and will be evaluated at the 'due_time' and 'due_days_of_week'. If false, this reminder is inactive and will not be evaluated. If active=false for user-specific reminders, then the company-wide reminder of the same reminder type will apply.
Enabled	Boolean	False	If true, the reminder is enabled and will be sent at the 'due_time' and 'due_days_of_week'. If false, the reminder is disabled and will not be sent. A user with an active (active = true), but disabled (enabled = false) reminder will not receive that reminder type regardless of how company-wide reminders are configured.
Created	Datetime	True	Date/time when this reminder was created
LastModified	Datetime	True	Date/time when this reminder was last modified,

Pseudo-Columns

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

Name	Type	Description
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Retrieves a list of schedule events associated with your employees or company.

Table Specific Information

Select

Query the ScheduleEvents table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id and ScheduleCalendarId fields support the '=' and IN operators.
• Start supports the '>=' operator.
• End supports the '<=' operator.
• ActiveStatus filter, and Draft and TeamEvents fields support the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM ScheduleEvents WHERE TeamEvents = 'instance'

SELECT * FROM ScheduleEvents WHERE LastModified > '2019-01-01 18:30' AND Id IN (1, 2, 3)

SELECT * FROM ScheduleEvents WHERE End <= '2019-12-31 18:00'

Insert

Insert can be executed by specifying ScheduleCalendarId, Start, End and AllDay columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO ScheduleEvents (ScheduleCalendarId, Start, End, AllDay) VALUES ('37', '2018-12-05T16:00:00+00:00', '2020-12-05T16:00:00+00:00', 'true')

INSERT INTO ScheduleEvents (ScheduleCalendarId, Start, End, AllDay, AssignedUserIds) VALUES ('37', '2018-12-05T16:00:00+00:00', '2020-12-05T16:00:00+00:00', 'true', '11, 1365, 729')

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE ScheduleEvents SET Title = 'New Title'  WHERE Id = '14055' 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Id of the schedule calendar.
ScheduleCalendarId	Integer	True	Id of the calendar that contains this event.
Start	Datetime	False	Date/time that represents the start time of this schedule event.
End	Datetime	False	Date/time that represents the end time of this schedule event.
AllDay	Boolean	False	If true, the event duration is all day on the day specified in start. If false, the event duration is determined by date/time specified in end.
AssignedUserIds	String	True	Ids of the user(s) assigned to this event. Empty array if the event is unassigned.
JobcodeId	String	False	Id of the jobcode associated with this event.
Active	Boolean	False	Whether the event is active. If false, the event has been deleted/archived.
Draft	Boolean	False	Whether the event the event is a draft. If false, the event is published. Saving a published event will send the appropriate event published notifications to the assigned users.
TimeZone	String	False	Timezone of the schedule event.
Title	String	False	Title or name of this event.
Notes	String	False	Notes associated with the event.
Location	String	False	Location of the event. Location can be an address, business name, GPS coordinate, etc., so when users click on the location it will open it up in their mapping application.
Color	String	False	Hex color code assigned to this schedule event.
Created	Datetime	True	Date/time when this schedule event was created
LastModified	Datetime	True	Date/time when this schedule event was last modified.

Pseudo-Columns

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

Name	Type	Description
TeamEvents	String	Possible values: base or instance. Default is 'instance'. If 'instance' is specified, events that are assigned to multiple users will be returned as individual single events for each assigned user. If 'base' is specified, events that are assigned to multiple users will be returned as one combined event for all assignees.
ActiveUsers	Integer	'0', '-1' or '1' . Default is '1'. Only schedule events whose users are active will be returned by default. 0 will return events for inactive users. -1 will return events for active and inactive users.
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

This table contains a list of file objects.

Table Specific Information

Select

Query the Timesheets table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id, UserId, JobcodeId, PayrollIds, GroupIds fields support the '=' and IN operators.
• OnTheClock and JobCodeType fields support the '=' operator.
• LastModified and Date fields support the <=,<=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Timesheets WHERE OnTheClock = false

SELECT * FROM Timesheets WHERE LastModified > '2019-01-01 18:30' AND GroupIds IN (1, 2, 3)

SELECT * FROM Timesheets WHERE JobcodeId IN (1, 2, 3)

Insert

Insert can be executed by specifying UserId, JobcodeId, Type and StartTime, EndTime columns in case of Type = regular or UserId, JobcodeId, Type and Duration, Date in case of Type = manual. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO Timesheets (UserId, JobcodeId, Type, StartTime, EndTime) VALUES ('1242123', '17288283', 'regular', '2019-12-05', '2019-12-05')

INSERT INTO Timesheets (UserId, JobcodeId, Type, Date, Duration) VALUES ('1242123', '17288283', 'manual', '2019-12-05', 600)

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Timesheets SET Date = '2018-08-08', EndTime = '2018-08-08T14:00:00-07:00'  WHERE Id = '1242123'  

Delete

Delete can be executed by specifying the Id in the WHERE Clause. For example:

DELETE FROM Timesheets WHERE Id = '41321421'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id of the timesheet.
UserId	String	False	User id for the user that this timesheet belongs to.
JobcodeId	Int	False	Jobcode id for the jobcode that this timesheet is recorded against.
Locked	Boolean	True	If greater than 0, the timesheet is locked for editing. A timesheet could be locked for various reasons.
Notes	String	False	Notes associated with this timesheet.
LastModified	Datetime	True	Date/time when this timesheet was last modified.
Type	String	False	Either 'regular' or 'manual'.
OnTheClock	Boolean	True	If true, the user is currently on the clock . If false the user is not currently working on this timesheet. Manual timesheets will always have this property set as false.
CreatedByUserId	String	False	User id for the user that initially created this timesheet.
StartTime	Datetime	False	Date/time that represents the start time of this timesheet. Will always be an empty string for manual timesheets.
EndTime	Datetime	False	Date/time that represents the end time of this timesheet. Will always be an empty string for manual timesheets.
Date	Date	False	The timesheet's date
Duration	Int	False	The total number of seconds recorded for this timesheet.
OriginHint	String	False	A string that will be logged as part of the timesheet history when someone is clocked in, clocked out, or a timesheet is created (with both in/out). Will always be an empty string for manual timesheets.
JobCodeType	String	True	The type of the jobcode linked with this timesheet. Any of the 'regular', 'pto', 'paid_break', 'unpaid_break'

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
PayrollIds	Int	A comma-separated string of payroll ids. Only time recorded against users with these payroll ids will be returned.
GroupIds	Int	A comma-separated list of group ids. Only timesheets linked to users from these groups will be returned.

Retrieves a list of all users associated with your company.

Table Specific Information

Select

Query the Users table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id, GroupId, Username, PayrollId and EmployeeNumber fields support the '=' and IN operators.
• FirstName and LastName fields support the '=' and LIKE operators.
• ActiveStatus filter supports the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE ActiveStatus = 'both'

SELECT * FROM Users WHERE LastModified > '2019-01-01 18:30' AND GroupId IN (1, 2, 3)

SELECT * FROM Users WHERE FirstName LIKE 'josh%' AND PayrollId IN ('562348', '45457')

Insert

Insert can be executed by specifying UserName, FirstName and LastName columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table

INSERT INTO Users (UserName, FirstName, LastName) VALUES ('cdatagroup@123', 'cdata', 'group')

Update

Update can be executed by specifying the Id or UserName in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Users SET FirstName = 'New Name'  WHERE Id = '14055' 

UPDATE Users SET FirstName = 'New User Name', LastName = 'New Title' WHERE UserName = 'cdatagroup@123' 

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	False	Id of this user.
FirstName	String	False	First name of user.
LastName	String	False	Last name of user.
DisplayName	String	False	The display name of user. NOTE: field will be null unless feature GED_INCLUSION is enabled (contact support for more info), if feature is enabled then value will be a non-null display_name value (users who have not setup their display_name will return empty string)
Pronouns	String	False	The personal pronouns of user. NOTE: field will be null unless feature GED_INCLUSION is enabled (contact support for more info), if feature is enabled then value will be a non-null pronouns value (users who have not setup their pronouns will return empty string)
GroupId	Integer	False	Id of the group this user belongs to.
Active	Boolean	False	Whether this user is active. If false, this user is considered archived.
EmployeeNumber	Integer	False	Unique number associated with this user.
Salaried	Boolean	False	Indicates whether or not the user is salaried.
Exempt	Boolean	False	Indicates whether or not the user is eligible for overtime pay.
Username	String	False	Username associated with this user.
Email	String	False	Email address associated with this user.
EmailVerified	Boolean	False	Indicates whether or not the user is eligible for overtime pay.
PayrollId	String	False	Unique company wide string associated with this user. Usually used for linking with external systems.
HireDate	Date	False	Date on which this user was hired.
TermDate	Date	False	Date on which this user was terminated.
LastModified	Datetime	False	Date/time when this user was last modified.
LastActive	Datetime	False	Date/time when this user last performed any action.
Created	Datetime	False	Date/time when this user was created
ClientUrl	String	False	Client account url identifier associated with this user.
CompanyName	String	False	Client account name identifier associated with the user.
ProfileImageUrl	String	False	Url identifier associated with this user's profile image.
MobileNumber	String	False	Mobile phone number associated with this user.
PTOBalances	String	False	List of jobcode identifiers and their respective PTO balances for this user (in seconds).
SubmittedTo	Date	False	The latest date this user has submitted timesheets up to.
ApprovedTo	Date	False	The latest date this user has had timesheets approved to.
ManagerOfGroupIds	String	False	The group ids that this user manages.
RequirePasswordChange	Boolean	False	Whether this user will be required to change their password on their next login.
LoginPIN	Integer	False	Used for logging into a Kiosk or similar.
PayRate	Double	False	The rate of pay associated with this user. Only visible to admins.
PayInterval	String	False	The timeframe to which this user's pay rate applies, either 'hour' or 'year'. Only visible to admins.

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
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

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.

CData Cloud - TSheets Views

Name	Description
CurrentTotalsReport	Report for the current totals (shift and day) along with additional information provided for those who are currently on the clock.
Files	This table contains a list of file objects.
GeneralSettings	Retrieves a list of all effective settings associated with a single user.
GeofenceConfigs	Retrieves a list of all geofence configs.
LastModifiedTimestamps	Retrieves a list of last_modified timestamps associated with each requested API endpoint.
LocationMaps	Retrieves a list of all locations maps associated with your company.
ManagedClients	Retrieves a list of managed clients available from your account.
PayrollReport	Payroll Report associated with a timeframe.
PayrollReportByJobCode	Payroll Report broken down by jobcode
ProjectReport	Retrieves a project report.
ScheduleCalendars	Retrieves a list of schedule calendars associated with your employees or company.
UserPermissions	The rights assignable to an individual user.

Report for the current totals (shift and day) along with additional information provided for those who are currently on the clock.

Table Specific Information

Select

Query the CurrentTotalsReport table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• GroupId, UserId and OnTheClock fields support the '=' and IN operators.

For example, the following query is processed server side:

SELECT * FROM CurrentTotalsReport WHERE GroupId IN ('29474', '29474') AND OnTheClock IN (true, false)

SELECT * FROM CurrentTotalsReport WHERE UserId IN (1751136, 1738864) AND OnTheClock = false

Columns

Name	Type	Description
UserId	Int	Id of the users these totals are calculated for.
GroupId	String	Unique group id for this user,value of zero represents those without a group.
OnTheClock	Boolean	Whether this user is currently on the clock.
ShiftGeolocationsAvailable	Boolean	Whether geolocations are available for the current timesheet.
ShiftSeconds	Int	Total time for the current shift, in seconds.
DaySeconds	Int	Total time for the day, in seconds.

This table contains a list of file objects.

Table Specific Information

Select

Query the Files table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id and Name fields support the '=' and IN operators.
• ActiveStatus filter supports the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM Files WHERE Name IN ('IMG_20181004_214839.png', 'healthy.jpg')

SELECT * FROM Files WHERE LastModified = '2019-01-01 15:30' AND ActiveStatus = 'both'

Columns

Name	Type	Description
Id [KEY]	String	Id of this file.
Name	String	Name of this file.
UploadByUserId	Int	Id of the user that uploaded this file.
Active	Boolean	If false, this file is considered deleted.
Size	Int	Size of the file in bytes.
Created	Datetime	Date/time when this customfield was created
LastModified	Datetime	Date/time when this customfield was last modified.
FileDescription	String	Description of this file.
ImageRotation	Int	Original image orientation in degrees. Accepted values are: 0 (top), 90 (right), 180 (bottom), 270 (left).

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
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Retrieves a list of all effective settings associated with a single user.

Table Specific Information

Select

Query the GeneralSettings table. All the filters are executed client side within the Cloud.

Columns

Name	Type	Description
CalculateOvertime	Boolean	The CalculateOvertime setting.
ClockoutOverride	Boolean	The ClockoutOverride setting.
ClockoutOverrideHours	Integer	The ClockoutOverrideHours setting.
ClockoutOverrideNotifyAdmin	Boolean	The ClockoutOverrideNotifyAdmin setting.
ClockoutOverrideNotifyManager	Boolean	The ClockoutOverrideNotifyManager setting.
DailyDoubletime	Integer	The DailyDoubletime setting.
DailyOvertime	Integer	The DailyOvertime setting.
DailyRegularHours	Integer	The DailyRegularHours setting.
DateLocale	String	The DateLocale setting.
EmpPanel	Boolean	The EmpPanel setting.
EmpPanelMail	String	The EmpPanelMail setting.
EmpPanelPassword	String	The EmpPanelPassword setting.
EmployeePtoEntry	Boolean	The EmployeePtoEntry setting.
EnableTimesheetNotes	String	The EnableTimesheetNotes setting.
HideWorkingTime	String	The HideWorkingTime setting.
JcLabel	String	The JcLabel setting.
LunchDeduct	Boolean	The LunchDeduct setting.
LunchLength	Boolean	The LunchLength setting.
LunchThreshold	Integer	The LunchThreshold setting.
MaxCustomFieldItems	Integer	The MaxCustomFieldItems setting.
MaxJobCodes	Integer	The MaxJobCodes setting.
ParentClockinDisplay	Integer	The ParentClockinDisplay setting.
PayrollEndDate	Date	The PayrollEndDate setting.
PayrollFirstEndDay	String	The PayrollFirstEndDay setting.
PayrollLastEndDay	String	The PayrollLastEndDay setting.
PayrollMonthEndDay	String	The PayrollMonthEndDay setting.
PayrollType	String	The PayrollType setting.
PtoEntry	Boolean	The PtoEntry setting.
PtoOvertime	Boolean	The PtoOvertime setting.
SimpleClockin	Boolean	The SimpleClockin setting.
TimeFormat	Integer	The TimeFormat setting.
TimecardFields	String	The TimecardFields setting.
TimeclockLabel	String	The TimeclockLabel setting.
TimesheetEditNotesForAllUsers	Boolean	The TimesheetEditNotesForAllUsers setting.
TimesheetNotesNotifyAdmin	Boolean	The TimesheetNotesNotifyAdmin setting.
TimesheetNotesNotifyManagers	Boolean	The TimesheetNotesNotifyManagers setting.
TimesheetNotesRequired	Boolean	The TimesheetNotesRequired setting.
Timezone	String	The Timezone setting.
WeekStart	String	The WeekStart setting.
WeeklyRegularHours	String	The WeeklyRegularHours setting.
LastModified	Datetime	When the record was last modified.

Retrieves a list of all geofence configs.

Table Specific Information

Select

Query the GeofenceConfigs table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id, TypeId and Type fields support the '=' and IN operators.
• Enabled field and ActiveStatus filter support the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM GeofenceConfigs WHERE TypeId IN (282316, 323445) AND Type = 'Locations'

SELECT * FROM GeofenceConfigs WHERE Enabled = false

Columns

Name	Type	Description
Id [KEY]	Int	Id of geofence config.
Type	String	The type of entity the geofence config is related to.
TypeId	Int	The id of the entity the geofence config is related to.
Active	Boolean	Whether this geofence config is active. If false, this geofence config is archived.
Enabled	Boolean	Indicates whether a geofence for the associated entity should be enabled.
Radius	Int	Configures the size of the geofence.
Created	Datetime	Date/time when this geofence config was created
LastModified	Datetime	Date/time when this geofence config was last modified.

Pseudo-Columns

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

Name	Type	Description
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Retrieves a list of last_modified timestamps associated with each requested API endpoint.

Table Specific Information

Select

Query a list of last modified timestamps associated with each requested API endpoint.

For example, the following queries are processed server side:

SELECT * FROM LastModifiedTimestamps WHERE endpoints = 'timesheets,current_user,groups'

Columns

Name	Type	Description
CurrentUser	Datetime	Date/time when this current user was last modified.
CustomFields	Datetime	Date/time when this custom fields was last modified.
CustomFielditems	Datetime	Date/time when this custom field items was last modified.
CustomFieldItemFilters	Datetime	Date/time when this custom field item filters was last modified.
CustomFieldItemUserFilters	Datetime	Date/time when this custom field item user filters was last modified.
CustomFieldItemJobCodeFilters	Datetime	Date/time when this custom field item jobcode filters was last modified.
ContactInfo	Datetime	Date/time when this contact info was last modified.
EffectiveSettings	Datetime	Date/time when this effective settings was last modified.
GeoLocations	Datetime	Date/time when this geo locations was last modified.
GeofenceConfigs	Datetime	Date/time when this geofence configs was last modified.
GeofenceActiveHours	Datetime	Date/time when this geofence active hours was last modified.
Groups	Datetime	Date/time when this groups was last modified.
JobCodes	Datetime	Date/time when this job codes was last modified.
JobCodeAssignments	Datetime	Date/time when this job code assignments was last modified.
Locations	Datetime	Date/time when this locations deleted was last modified.
LocationsMap	Datetime	Date/time when this locations map was last modified.
Reminders	Datetime	Date/time when this reminders was last modified.
ScheduleCalendars	Datetime	Date/time when this schedule calendars was last modified.
ScheduleEvents	Datetime	Date/time when this schedule events was last modified.
TimeSheets	Datetime	Date/time when this timesheets was last modified.
TimeSheetsDeleted	Datetime	Date/time when this timesheets deleted was last modified.
TimeOffRequests	Datetime	Date/time when this time off requests was last modified.
TimeOffRequestEntries	Datetime	Date/time when this time off request entries was last modified.
Terms	Datetime	Date/time when this terms was last modified.
Users	Datetime	Date/time when this users was last modified.

Pseudo-Columns

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

Name	Type	Description
Endpoints	String	Comma separated list of one or more endpoints.

Retrieves a list of all locations maps associated with your company.

Table Specific Information

Select

Query the LocationMaps table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id field supports the '=' and IN operators.
• ByJobcodeAssignment field supports the '=' operator.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM LocationMaps WHERE Id IN ('102839', '110761')

SELECT * FROM LocationMaps WHERE ByJobcodeAssignment = true

Columns

Name	Type	Description
Id [KEY]	String	Id of location map.
XTable	String	The name of the entity the location is mapped to.
XId	Integer	The id of the entity the location is mapped to.
LocationId	Integer	The id of the location that is mapped to the entity.
Created	Datetime	Date/time when this locations map was created
LastModified	Datetime	Date/time when this locations map was last modified.

Pseudo-Columns

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

Name	Type	Description
ByJobcodeAssignment	Boolean	If specified only locations maps mapped to a jobcode the user is assigned to will be returned.

Retrieves a list of managed clients available from your account.

Table Specific Information

Select

Query the ManagedClients table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• ActiveStatus filter supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM ManagedClients WHERE ActiveStatus = 'both'

Columns

Name	Type	Description
Id [KEY]	String	Id of the managed client.
CompanyUrl	String	URL used by the managed client to sign in to TSheets.
CompanyName	String	Name of the managed client's company.
Active	Boolean	Whether this client is active. If false, this client is considered archived.
Created	Datetime	Date/time when this managed client record was created
LastModified	Datetime	Date/time when this managed client record was last modified.

Pseudo-Columns

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

Name	Type	Description
ActiveStatus	String	Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both

Payroll Report associated with a timeframe.

Table Specific Information

Select

Query the PayrollReport table to retrieve payrolls associated with a timeframe, with filters to narrow down the results. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. By default the report will include results for a time range within the last 30 days. You can filter by StartDate and EndDate filters to get a payroll report over a different time range.

• UserId and GroupId fields support the '=' and IN operators.
• StartDate, EndDate and IncludeZeroTime fields support the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PayrollReport WHERE GroupId IN ('29474', '29475') AND IncludeZeroTime = false
SELECT * FROM PayrollReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Columns

Name	Type	Description
UserId	Int	Id of the users these totals are calculated for.
ClientId	Int	Id of the client.
StartDate	Date	Start of reporting timeframe.
EndDate	Date	End of the payroll reporting timeframe.
TotalReSeconds	Int	Total time for the current shift, in seconds.
TotalOTSeconds	Int	Overtime, in seconds.
TotalDTSeconds	Int	Doubletime, in seconds.
TotalPTOSeconds	Int	Total PTO time, in seconds.
TotalWorkSeconds	Int	Total overall time, in seconds.
OvertimeSeconds	String	The overtime seconds object, where the key is the multiplier rate and the value is the number of seconds of overtime at that rate
FixedRateSeconds	String	The fixed rate seconds object, where the key is the multiplier rate and the value is the number of seconds of overtime at that rate

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
GroupId	String	A comma-seperated list of group ids. Only time for users from these groups will be included.
IncludeZeroTime	String	If true, all users will be included in the output, even if they had zero hours for the time period.

Payroll Report broken down by jobcode

Table Specific Information

Select

Query the PayrollReportByJobCode table to retrieve a payroll report, broken down by jobcode, with filters to narrow down the results. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. By default the report will include results for a time range within the last 30 days. You can filter by StartDate and EndDate filters to get a payroll report over a different time range. The date range defined by StartDate and EndDate must not exceed 31 days.

• GroupId field supports the '=' and IN operators.
• StartDate, EndDate and IncludeAdvancedOvertime fields support the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PayrollReportByJobCode WHERE GroupId IN ('29474', '29474') AND IncludeAdvancedOvertime = false
SELECT * FROM PayrollReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Based on the columns selected in projection explicitly, the aggregated data displayed may change. Aggregate payroll metrics broken down by jobcode id:

SELECT * FROM PayrollReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Aggregate payroll metrics broken down by jobcode id per each user:

SELECT UserId, JobCodeId, TotalWorkSeconds, TotalReSeconds, TotalPtoSeconds, OvertimeSeconds FROM PayrollReportByJobCode

Aggregate payroll metrics broken down by jobcode id and date per each user:

SELECT Date, UserId, JobCodeId, TotalWorkSeconds, TotalReSeconds, TotalPtoSeconds, OvertimeSeconds FROM PayrollReportByJobCode

Columns

Name	Type	Description
UserId	Int	Id of the users these totals are calculated for.
JobcodeId	Int	Id of the jobcode the metrics apply to.
StartDate	Date	Start of reporting timeframe.
EndDate	Date	End of the payroll reporting timeframe.
Date	String	Date that these total are calculated for.
TotalReSeconds	Int	Total time for the current shift, in seconds.
TotalOTSeconds	Int	Overtime, in seconds.
TotalDTSeconds	Int	Doubletime, in seconds.
TotalPTOSeconds	Int	Total PTO time, in seconds.
TotalWorkSeconds	Int	Total overall time, in seconds.
OvertimeSeconds	String	The overtime seconds object, where the key is the multiplier rate and the value is the number of seconds of overtime at that rate
FixedRateSeconds	String	The fixed rate seconds object, where the key is the multiplier rate and the value is the number of seconds of overtime at that rate

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
GroupId	String	A comma-seperated list of group ids. Only time for users from these groups will be included.
IncludeAdvancedOvertime	Boolean	If true, overtime will be formatted such that it includes the time for individual multipliers and can support more than just 1.5x (ot) and 2x (dt) overtime.

Retrieves a project report.

Table Specific Information

Select

Query the ProjectReport table to retrieve a project report, broken down by user, group or jobcode. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud. By default the report will include results for a time range within the last 30 days. You can filter by StartDate and EndDate filters to get a payroll report over a different time range.

• UserId, JobcodeId and GroupId fields support the '=' and IN operators.
• StartDate and EndDate fields support the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM ProjectReport WHERE GroupId IN (29474, 29474)
SELECT * FROM ProjectReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Based on the columns selected in projection explicitly, the aggregated data displayed may change. Aggregate projects metrics broken down by user id:

SELECT * FROM ProjectReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'
SELECT UserId, TotalHours FROM ProjectReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Aggregate project metrics broken down by jobcode id:

SELECT JobCodeId, TotalHours FROM ProjectReport

Aggregate payroll metrics broken down by group id:

SELECT GroupId, TotalHours FROM ProjectReport

Columns

Name	Type	Description
UserId	Int	Id of the users these totals are calculated for.
JobcodeId	Int	Id of the jobcode the metrics apply to.
GroupId	Int	Id of the group the metrics apply to.
StartDate	Date	Start of reporting timeframe.
EndDate	Date	End of the payroll reporting timeframe.
TotalHours	Double	Total number of hours per each user, group or jobcode.

Retrieves a list of schedule calendars associated with your employees or company.

Table Specific Information

Select

Query the ScheduleCalendars table. The Cloud will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id field supports the '=' and IN operators.
• LastModified field supports the <=,<,>=,>,= operators.

For example, the following queries are processed server side:

SELECT * FROM ScheduleCalendars WHERE Id IN (72595, 72597)

SELECT * FROM ScheduleCalendars WHERE LastModified < '2019-01-01 18:30'

Columns

Name	Type	Description
Id [KEY]	Integer	Id of the schedule calendar.
Name	String	The name of the schedule calendar.
Created	Datetime	Date/time when this schedule calendar was created
LastModified	Datetime	Date/time when this schedule calendar was last modified.

The rights assignable to an individual user.

Table Specific Information

Select

Query the UserPermissions table. All the filters are executed client side within the Cloud.

Columns

Name	Type	Description
UserId [KEY]	String	The Id of the user these permissions apply to.
Admin	Boolean	Administrator, can perform any changes on the account.
Mobile	Boolean	Whether this user is allowed to use mobile devices to record time.
StatusBox	Boolean	Whether this user is able to view the list of users currently working for the company.
Reports	Boolean	Whether this user is able to run/view all reports for the company.
ManageTimesheets	Boolean	Whether this user is able to create/edit/delete timesheets for anyone in the company.
ManageAuthorization	Boolean	Whether this user is able to manage computer authorization for the company.
ManageUsers	Boolean	Whether this user is able to create/edit/delete users, groups, and managers for the entire company.
ManageMyTimesheets	Boolean	Whether this user is able to completely manage own timesheets.
ManageJobcodes	Boolean	Whether this user is able to create/edit/delete jobcodes and custom field items for the entire company.
PinLogin	Boolean	Whether this user is able to login to apps via PIN.
ApproveTimesheets	Boolean	Whether this user is able to run approval reports and approve time for all employees.
ManageSchedules	Boolean	Whether this user is able to create/edit/delete events within the schedule for the groups that the user can manage.
ManageMySchedule	Boolean	Whether this user is able to create/edit/delete events within the schedule for only themselves.
ManageCompanySchedules	Boolean	Whether this user is able to create/edit/delete events within the schedule for any user in the company.
ManageNoSchedule	Boolean	Whether this user is not able to create/edit/delete events within the schedule for any user.
ViewCompanySchedules	Boolean	Whether this user is able to view published events within the schedule for any user in the company.
ViewGroupSchedules	Boolean	Whether this user is able to view published events within the schedule for the groups that the user is a member of.
ViewMySchedules	Boolean	Whether this user is able to view published events within the schedule for themselves.

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

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

CData Cloud - TSheets Stored Procedures

Name	Description
CreateInvitation	Invite one or more users to your company.

Invite one or more users to your company.

Input

Name	Type	Required	Description
ContactMethod	String	False	Method to be used for the invitation, either 'sms' or 'email'.
ContactInfo	String	False	The email address or mobile phone number matching the type specified by the contact_method parameter.
UserId	String	False	Id of the user to invite.
ContactAggregate	String	False

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for TSheets:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Timesheets table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Timesheets' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CreateInvitation stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateInvitation' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Timesheets table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Timesheets' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:tsheets:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

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.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

---

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

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

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

Miscellaneous

---

Property	Description
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from TSheets.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

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

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

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

Data Type

string

Default Value

""

Remarks

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

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

Data Type

string

Default Value

""

Remarks

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

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

---

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

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

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:

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 Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

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

---

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

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

Data Type

string

Default Value

""

Remarks

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

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

---

Property	Description
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from TSheets.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

A boolean indicating if you would like to include custom fields in the column listing.

Data Type

bool

Default Value

true

Remarks

Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

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

Data Type

int

Default Value

50

Remarks

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

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

Data Type

string

Default Value

""

Remarks

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

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

Data Type

int

Default Value

60

Remarks

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

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