CData Sync App は、TSheets データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
TSheets コネクタはCData Sync アプリケーションから使用可能で、TSheets からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、TSheets への接続を作成します。TSheets アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからTSheets コネクタをダウンロードおよびインストールします。
必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。
TSheets は、認証および認可にOAuth2 標準を使用します。独自のOAuth アプリを構築してデータに接続するには、OAuth 認証の使用 を参照してください。
このセクションでは、TSheets Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、TSheets にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、TSheets API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、Timesheets、Users、Files などを静的にモデル化するように定義されています。
Sync App はTSheets のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、TSheets テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
| 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.
Query the GeoLocations table. The Sync App 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 Sync App.
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 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')
| 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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the Groups table. The Sync App 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 Sync App.
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 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 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'
| 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.
Query the JobcodeAssignments table. The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM JobcodeAssignments WHERE UserId IN (1242515, 1242515) SELECT * FROM JobcodeAssignments WHERE JobCodeParentId = 17285791
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 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')
| 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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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
Query the Jobcodes table. The Sync App 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 Sync App.
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 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 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'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the Locations table. The Sync App 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 Sync App.
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 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 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'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the Notifications table. The Sync App 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 Sync App.
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 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 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')
| 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.
Query the Reminders table. The Sync App 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 Sync App.
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 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 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'
| 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, |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the ScheduleEvents table. The Sync App 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 Sync App.
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 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 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'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the Timesheets table. The Sync App 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 Sync App.
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 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 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 can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Timesheets WHERE Id = '41321421'
| 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' |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the Users table. The Sync App 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 Sync App.
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 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 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'
| 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. |
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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 |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
| 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.
Query the CurrentTotalsReport table. The Sync App 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 Sync App.
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
| 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.
Query the Files table. The Sync App 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 Sync App.
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'
| 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). |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the GeneralSettings table. All the filters are executed client side within the Sync App.
| 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.
Query the GeofenceConfigs table. The Sync App 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 Sync App.
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
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
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'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Endpoints | String | Comma separated list of one or more endpoints. |
Retrieves a list of all locations maps associated with your company.
Query the LocationMaps table. The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM LocationMaps WHERE Id IN ('102839', '110761')
SELECT * FROM LocationMaps WHERE ByJobcodeAssignment = true
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the ManagedClients table. The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM ManagedClients WHERE ActiveStatus = 'both'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the PayrollReport table to retrieve payrolls associated with a timeframe, with filters to narrow down the results. The Sync App 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 Sync App. 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.
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'
| 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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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
Query the PayrollReportByJobCode table to retrieve a payroll report, broken down by jobcode, with filters to narrow down the results. The Sync App 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 Sync App. 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.
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
| 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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| 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.
Query the ProjectReport table to retrieve a project report, broken down by user, group or jobcode. The Sync App 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 Sync App. 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.
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
| 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.
Query the ScheduleCalendars table. The Sync App 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 Sync App.
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'
| 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.
Query the UserPermissions table. All the filters are executed client side within the Sync App.
| 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. |
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュール。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
| MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | TSheets から返されるページあたりの結果の最大数。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります：
| 説明 | 例 |
| フルPEM 証明書（例では省略されています） | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵（例では省略されています） | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint （hex 値はスペースおよびコロン区切り） | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint （hex 値はスペースおよびコロン区切り） | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
| タイプ | デフォルトポート | 説明 |
| TUNNEL | 80 | これが設定されている場合、Sync App はTSheets への接続を開き、プロキシを経由して通信が行われます。 |
| SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
| AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\TSheets Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
| MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | TSheets から返されるページあたりの結果の最大数。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
A boolean indicating if you would like to include custom fields in the column listing.
Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
TSheets から返されるページあたりの結果の最大数。
Pagesize プロパティは、TSheets から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Timesheets WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"