Adding a Connection to Garoon

To add a connection to Garoon:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Garoon icon is not available, click the Add More icon to download and install the Garoon connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Garoon

In addition to the authentication values, set the following parameters to connect to and retrieve data from Garoon:

• Url: The URL of your account.

NOTE: Here are accepted URL format for supported versions:

• Cloud version : https://(subdomain).cybozu.com
• Package version (Windows environment) : http://(server IP address or host name)/scripts/(installation identifier)/grn.exe
• Package version (Linux environment) : http://(server IP address or host name)/cgi-bin/(installation identifier)/grn.cgi

Authenticating to Garoon

Garoon supports the following authentication methods.

Password

You must set the following to authenticate to Garoon:

• User: The username of your account.
• Password: The password of your account.
• AuthScheme: Set AuthScheme to Password.

Additional Security

In addition to the mentioned authentication schemes, Garoon offers additional security in the form of both an additional Basic Auth header, and an SSL Certificate.

Basic

Garoon environments using basic authentication will need to pass additional basic credentials. To do so, specify the following:

• BasicAuthUser - The basic login name.
• BasicAuthPassword - The basic password.

Client SSL

In addition to your authentication information, Garoon may be configured to require an SSL certificate to accept requests. To do so, set the following:

• SSLClientCert - The file containing the certificate of the SSL Cert. Or alternatively, the name of the certificate store for the client certificate.
• SSLClientCertType - The type of certificate.
• SSLClientCertSubject - (Optional) If searching for a certificate in the certificate store, the store is searched for subjects containing the value of the property.
• SSLClientCertPassword - If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

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

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Garoon and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

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

Customizing the SSL Configuration

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

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

Client SSL Certificates

The Garoon Sync App also supports setting client certificates. Set the following to connect using a client certificate.

• SSLClientCert: The name of the certificate store for the client certificate.
• SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
• SSLClientCertPassword: The password for the TLS/SSL client certificate.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate.

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

Key Features

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

Tables

Tables describes the available tables. Tables are statically defined to model Events, NotificationItems, UserPresence.

Views

Views describes the available views. Views are statically defined to model EventAttendees, Users, Requests, etc.

Stored Procedures

Stored Procedures are function-like interfaces to Garoon. Stored procedures allow you to execute operations to Garoon, including downloading documents and moving envelopes.

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

Garoon Connector for CData Sync Tables

Name	Description
Events	Query, create, modify, and delete regarding events.
NotificationItems	Query, create, modify regarding notification items.
UserPresence	Query, modify regarding presence users.

Query, create, modify, and delete regarding events.

Select

The Sync App will use the Garoon 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.

• DateTime supports the <, <=, =, >= and > operators.
• TargetType supports the '=' operator.
• Target supports the '=' operator.

NOTE: Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). For example, the following queries are processed server side:

SELECT * FROM Events WHERE DateTime >= '2019-11-22 00:00:00.0'
SELECT * FROM Events WHERE DateTime > '2019-11-22 00:00:00.0'
SELECT * FROM Events WHERE targetType = 'user' AND target = '4'

Update

Columns with ReadOnly false can be updated.

UPDATE Events 
SET EventMenu = 'test', Subject = 'test', Notes = 'TEMPORARY', visibilityType = 'PRIVATE', useAttendanceCheck = false, CompanyInfoName = 'CompanyName', CompanyInfoZipCode = 'CompanyZipCode',
 CompanyInfoAddress = 'CompanyAddress', CompanyInfoRoute = 'CompanyRoute', CompanyInfoRouteTime = '2020', CompanyInfoRouteFare = '223', CompanyInfoPhone = '24342232342' , 
 StartDateTime = '2019-01-28T06:51:24Z', StartTimeZone = 'Asia/Tokyo', EndDateTime = '2019-01-28T06:51:24Z', EndTimeZone = 'Asia/Tokyo', isAllDay = true, isStartOnly = false, AdditionalItemsItemValue = 'test'
 WHERE Id = 35

Using temporary tables:

INSERT INTO Watchers#TEMP (Code, Type) VALUES ('User1', 'USER')
INSERT INTO Watchers#TEMP (Code, Type) VALUES ('User2', 'USER')
INSERT INTO Watchers#TEMP (Code, Type) VALUES ('User3', 'USER')
UPDATE Events SET Watchers = 'Watchers#TEMP' WHERE Id = 35

Using aggregates:

UPDATE Events SET Watchers = '[
    {
      "type": "USER",
      "code": "c000001"
    }
  ]', visibilityType = 'SET_PRIVATE_WATCHERS' WHERE Id = 35
UPDATE Events SET Attendees = '[
    {
      "type": "USER",
      "code": "c000001"
    }
  ]' WHERE Id = 35
  UPDATE Events SET facilities = '[
    {
      "code": "F001"
    }
  ]' WHERE Id = 35

Insert

To add an Event, you should specify at least one of these column combinations:
a) EventType, StartDateTime, StartTimeZone, EndDateTime, EndTimeZone and Facilities columns.
b) EventType, StartDateTime, StartTimeZone, EndDateTime, EndTimeZone and Attendees columns.
d) EventType, StartDateTime, StartTimeZone, IsStartOnly(to true) and Facilities columns.
e) EventType, StartDateTime, StartTimeZone, IsStartOnly(to true) and Attendees columns.

Using temporary tables:

INSERT INTO EventAttendees#TEMP (Code, Type) VALUES ('User', 'USER')
INSERT INTO Events (EventType, StartDateTime, StartTimeZone, IsStartOnly, Attendees) VALUES ('REGULAR', '2020-09-27T14:00:00+09:00', 'Asia/Tokyo', true, 'EventAttendees#TEMP')

INSERT INTO EventFacilities#TEMP (Code) VALUES ('FacilityGroupsFacility1')
INSERT INTO Events (EventType, StartDateTime, StartTimeZone, EndDateTime, EndTimeZone, Facilities) VALUES ('REGULAR', '2020-09-17T14:00:00', 'Asia/Tokyo', '2020-09-17T15:00:00', 'Asia/Tokyo', 'EventFacilities#TEMP')

Inserting events with attachments. (Base64 encoding is required for the content of the attachment.)

INSERT INTO EventAttendees#TEMP (Code, Type) VALUES ('Endri', 'USER')
INSERT INTO EventAttachments#TEMP (name, contentType, content) VALUES ('test1.txt', 'plain/text', 'dGVzdA==')
INSERT INTO EventAttachments#TEMP (name, contentType, content) VALUES ('test2.txt', 'plain/text', 'dGVrdrdr33zdA==')
INSERT INTO Events (EventType, StartDateTime, StartTimeZone, isStartOnly, Attendees, Attachments ) VALUES ('REGULAR', '2020-09-27T14:00:00+09:00', 'Asia/Tokyo', true, 'EventAttendees#TEMP', 'EventAttachments#TEMP')

Using aggregates:

INSERT INTO Events (EventType, StartDateTime, StartTimeZone, EndDateTime, EndTimeZone, IsStartOnly, Facilities) VALUES ('REGULAR', '2020-09-27T14:00:00', 'Asia/Tokyo', '2020-09-27T15:00:00', 'Asia/Tokyo', false, '[
    {
      "code": "F001"
    }
  ]')

Delete

Events can be deleted by providing Id of the event.

DELETE FROM Events WHERE Id = 34

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Composed id of the event.
EventId	Int	True	Id of the event.
CreatorId	Int	True	Id of the creator.
CreatorCode	String	True	Code of the creator.
CreatorName	String	True	Name of the creator.
CreatedAt	Datetime	True	Created time.
UpdaterId	Int	True	Id of the updater.
UpdaterCode	String	True	Code of the updater.
UpdaterName	String	True	Name of the updater.
UpdatedAt	Datetime	True	Updated time.
EventType	String	False	Type of the event.
EventMenu	String	False	Menu of the event.
Subject	String	False	Subject of the event.
Notes	String	False	Notes of the event.
VisibilityType	String	False	Type of visibility.
UseAttendanceCheck	Boolean	False	Use attendance check.
Attachments	String	True	Attachments of the event.
Attendees	String	False	Attendees of the event.
AttendeesCandidate	String	True	Attendees candidate of the event.
CompanyInfoName	String	False	Name of company.
CompanyInfoZipCode	String	False	Zip code of company.
CompanyInfoAddress	String	False	Address of company.
CompanyInfoRoute	String	False	Route of company.
CompanyInfoRouteTime	String	False	Route time of company.
CompanyInfoRouteFare	String	False	Route fare of company.
CompanyInfoPhone	String	False	Phone number of company.
StartDateTime	Datetime	False	Time when event started.
StartTimeZone	String	False	Starting time zone.
EndDateTime	Datetime	False	Time when event ends.
EndTimeZone	String	False	Ending time zone.
IsAllDay	Boolean	False	When set to true, event is all day.
IsStartOnly	Boolean	False	When set to true,event is start only.
OriginalStartTimeZone	String	True	Original start time zone.
OriginalEndTimeZone	String	True	Original end time zone.
Watchers	String	False	Watchers of the event.
WatchersCandidate	String	True	Watchers candidate of the event.
Facilities	String	False	Facilities of the event.
FacilitiesCandidate	String	True	Facilities candidate of the event.
FacilityUsingPurpose	String	False	Facility using purpose
FacilityReservationInfo	String	True	Facility reservation info.
FacilityUsageRequests	String	True	Facility usage requests.
RepeatInfo	String	True	Repeat info.
TemporaryEventCandidates	String	True	Temporary event candidates.
AdditionalItemsItemValue	String	False	Additional items.
RepeatId	String	True	Repeat id.

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
DateTime	Datetime	Specify the date and time of the search target in RFC3339 format. Supported operators are =,<,>,<=,>=.
TargetType	String	Specify the type to narrow down the results by user, organization or facility. The allowed values are user, organization, facility.
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Query, create, modify regarding notification items.

View Specific Information

Garoon does not support any column for filtering this view. All filters will be executed client side.

Upsert

To add/update an NotificationItem, you should specify at least NotificationKey, Operation, Url, Title, App and Destinations(Code, Type and Id) columns.
Note : In the app value must be specified External notification code.
If an existing NotificationKey is specified in the query, API will update the existing record, otherwise a new record will be created.

Using temporary tables:

INSERT INTO Destinations#TEMP (Code, Type, id) VALUES ('cybozu', 'USER', 2)
UPSERT INTO NotificationItems (NotificationKey, Operation, Url, Title, App, Destinations) VALUES ('15', 'remove', 'https://developer.cybozu.io/hc/ja/articles/360026939911', 'Sample title', 'Concur', 'Destinations#TEMP')

Using aggregates:

UPSERT INTO NotificationItems (NotificationKey, Operation, Url, Title, App, Destinations) VALUES ('15', 'remove', 'https://developer.cybozu.io/hc/ja/articles/360026939911', 'Sample title', 'Concur', '[
    {
      "type": "USER",
      "code": "userCode",
      "id": "1"
    }
  ]')

Columns

Name	Type	ReadOnly	Description
NotificationKey [KEY]	String	True	Garoon notification key.
ModuleId [KEY]	String	True	Garoon module ID.
CreatorId	Int	True	Garoon user ID of the creator of the notification.
CreatorCode	String	True	Garoon user name of the creator of the notification.
CreatorName	String	True	Garoon user login name of the creator of the notification.
CreatedAt	Datetime	True	Notification creation date and time.
Operation	String	True	Summary of notification operations.You can specify one of the following three values:add,modify,remove.
Url	String	True	URL included in the notification.
Title	String	True	Notification title.
Body	String	True	Notification text.
Icon	String	True	Notification icon. A sample icon or URI can be specified.
IsRead	Boolean	True	Whether the notification has been read.

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
Destinations	String	List of notification destinations. This column is used for insert and does not return data.
App	String	Specify the external notification code set in Garoon's application management.

Query, modify regarding presence users.

Select

The Sync App will use the Garoon 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.

• Id supports the = operator.
• Code supports the = operator.

For example, the following query is processed server side:

SELECT * FROM UserPresence WHERE Id = 24 
SELECT * FROM UserPresence WHERE Code = 'admin'

Update

Columns with ReadOnly false can be updated.

UPDATE UserPresence SET StatusCode = 'attend', Notes = 'Sample note' WHERE Id = 2

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Garoon user ID
Name	String	True	Garoon user display name
Code	String	True	Garoon user login name
UpdatedAt	Datetime	True	Update time of presence information.The format is ISO8601 UTC time zone.
Notes	String	False	Memo.
StatusCode	String	False	Status code of presence information
StatusName	String	True	Status name of presence information.

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.

Garoon Connector for CData Sync Views

Name	Description
EventAttachments	Query information regarding event attachments.
EventAttendees	Query information regarding event attendees.
EventFacilities	Query information regarding event facilities.
EventWatchers	Query information regarding event watchers.
Facilities	Query information regarding facilities.
FacilityGroups	Query information regarding facility groups.
Files	Query information regarding files in a Request.
Organizations	Query information regarding organizations.
OrganizationUsers	Query information regarding organization users.
RequestItems	Query information regarding request items.
Requests	Query information regarding requests.
RequestSteps	Query information regarding request steps.
Users	Query information regarding users.

Query information regarding event attachments.

View Specific Information

The Sync App will use the Garoon 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.

• TargetType supports '=' operator.
• Target supports '=' operator.

NOTE: Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). For example, the following queries are processed server side:

SELECT * FROM EventAttachments WHERE TargetType = 'user' AND Target = '4'

Columns

Name	Type	Description
EventId [KEY]	Int	Id of the event.
EventStartDateTime [KEY]	Datetime	Time when event started.
EventEndDateTime [KEY]	Datetime	Time when event ends.
AttachmentId [KEY]	Int	Id of the attachment.
Name	String	Name of the attachment.
Size	Int	Size of the attachment.
ContentType	String	Content type of the attachment.

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
TargetType	String	Specify the type to narrow down the results by user, organization or facility. The allowed values are user, organization, facility.
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Query information regarding event attendees.

View Specific Information

The Sync App will use the Garoon 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.

• TargetType supports '=' operator.
• Target supports '=' operator.

NOTE: Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). For example, the following queries are processed server side:

SELECT * FROM EventAttendees WHERE TargetType = 'organization' AND Target = '4'

Columns

Name	Type	Description
EventId [KEY]	Int	Id of the event.
EventStartDateTime [KEY]	Datetime	Time when event started.
EventEndDateTime [KEY]	Datetime	Time when event ends.
AttendeeId [KEY]	Int	Id of the attendee.
Name	String	Name of the attendee
Code	String	Code of the attendee
Type	String	Type of the attendee

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
TargetType	String	Specify the type to narrow down the results by user, organization or facility. The allowed values are user, organization, facility.
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Query information regarding event facilities.

View Specific Information

The Sync App will use the Garoon 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.

• TargetType supports '=' operator.
• Target supports '=' operator.

NOTE: Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). For example, the following queries are processed server side:

SELECT * FROM EventFacilities WHERE TargetType = 'facility' AND Target = '4'

Columns

Name	Type	Description
EventId [KEY]	Int	Id of the event.
EventStartDateTime [KEY]	Datetime	Time when event started.
EventEndDateTime [KEY]	Datetime	Time when event ends.
FacilityId [KEY]	Int	Id of the facility.
Name	String	Name of the facility.
Code	String	Code of the facility.
Notes	String	Notes of the facility.

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
TargetType	String	Specify the type to narrow down the results by user, organization or facility. The allowed values are user, organization, facility.
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Query information regarding event watchers.

View Specific Information

The Sync App will use the Garoon 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.

• TargetType supports the '=' operator.
• Target supports the '=' operator.

NOTE: Target and TargetType fields should be used together in the query (i.e If target field is specified in the query, targetType field is also mandatory and vice versa). For example, the following queries are processed server side:

SELECT * FROM EventWatchers WHERE TargetType = 'user' AND Target = '4'

Columns

Name	Type	Description
EventId [KEY]	Int	Id of the event.
EventStartDateTime [KEY]	Datetime	Time when event started.
EventEndDateTime [KEY]	Datetime	Time when event ends.
WatcherId [KEY]	Int	Id of the watcher.
Name	String	Name of the watcher
Code	String	Code of the watcher
Type	String	Type of the watcher

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
TargetType	String	Specify the type to narrow down the results by user, organization or facility. The allowed values are user, organization, facility.
Target	String	Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Query information regarding facilities.

Select

The Sync App will use the Garoon 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.

• Id supports ORDER BY operator.
• FacilityGroupId supports = operator.

For example, the following queries are processed server side:

SELECT * FROM Facilities ORDER BY id
SELECT Code FROM Facilities
SELECT Id, Subject FROM Events ORDER BY startDateTime DESC LIMIT 2
SELECT * FROM Facilities WHERE FacilityGroupId = 1

Columns

Name	Type	Description
Id [KEY]	Int	Id of facility.
Name	String	Name of facility.
Code	String	Code of facility.
Notes	String	Notes of facility.
FacilityGroupId	Int	Group of facility.

Query information regarding facility groups.

View Specific Information

Garoon does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	Description
Id [KEY]	Int	Id of facility group.
Name	String	Name of facility group.
Code	String	Code of facility group.
Notes	String	Notes of facility group.
ParentFacilityGroupId	Int	Parent of facility group.
ChildFacilityGroups	String	Child of facility group.

Query information regarding files in a Request.

Select

The Sync App will use the Garoon 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.

• Id supports = operator.

For example, the following query is processed server side:

SELECT * FROM Files WHERE Id = 1

Columns

Name	Type	Description
Id [KEY]	Int	Id of file.
Name	String	Name of file.
ContentType	String	Content type of file.
Size	Int	Size of file.

Query information regarding organizations.

View Specific Information

Garoon does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	Description
Id [KEY]	Int	Organization ID.
Name	String	Organization name.
Code	String	Organization code.
ParentOrganization	Int	Parent organization ID.
ChildOrganizations	String	Child organization ID.

Query information regarding organization users.

Select

The Sync App will use the Garoon 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.

• OrganizationId supports the = operator.

For example, the following query is processed server side:

SELECT OrganizationId, UserId FROM OrganizationUsers WHERE OrganizationId = 24 

Columns

Name	Type	Description
OrganizationId	Int	Garoon organization ID
UserId [KEY]	Int	Garoon user ID
Name	String	Garoon user display name
Code	String	Garoon user login name

Query information regarding request items.

Select

The Sync App will use the Garoon 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.

• FormId supports = operator.
• StatusType supports = and IN operators.
• ApprovedAt supports <, <=, =, >= and > operators.

For example, the following query is processed server side:

SELECT * FROM RequestItems WHERE FormId = 3
SELECT * FROM RequestItems WHERE StatusType = 'REJECTED'
SELECT * FROM RequestItems WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM RequestItems WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM RequestItems WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

Name	Type	Description
RequestId [KEY]	Int	Id of the request.
FormId	Int	Form id of the request.
StatusType	String	Status of the request.
ItemId [KEY]	String	Id of the item.
ItemName	String	Name of the item.
Type	String	Type of the item.
Value	String	Value of the item.
Single_Line_Text_Value	String	Single line text value of the item.
Multi_Line_Text_Value	String	Multi line text value of the item.
Number_Value	Decimal	Number value of the item.
Calc_Value	Decimal	Calc value of the item.
Date_Value	String	Date value of the item.
DATETIME_Value	String	DateTime value of the item.
Radio_Button_Value	String	Radio button of the item.
Drop_Down_Value	String	Drop down value of the item.
Check_Box_Value	String	Check box value of the item.
Route_Navi_Value	String	Route navi value of the item.

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
ApprovedAt	Datetime	Specify the final approval date and time in RFC3339 format. Supported operators are =,<,>,<=,>=.

Query information regarding requests.

Select

The Sync App will use the Garoon 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.

• FormId supports = operator.
• StatusType supports = and IN operators.
• ApprovedAt supports <, <=, =, >= and > operators.

For example, the following query is processed server side:

SELECT * FROM Requests WHERE FormId = 3
SELECT * FROM Requests WHERE StatusType = 'REJECTED'
SELECT * FROM Requests WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM Requests WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM Requests WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

Name	Type	Description
Id [KEY]	Int	Id of the request.
StatusName	String	Name of the status.
StatusType	String	Type of status.
CreatedAt	Datetime	Creation date and time.The format is ISO8601 UTC time zone.
UpdatedAt	Datetime	Update date and time.The format is ISO8601 UTC time zone.
ProcessingStepCode	String	Step code of route step.
Name	String	Name of the request.
Number	String	Number of the request.
IsUrgent	Boolean	Whether the request is urgent.
ApplicantId	Int	Id of the applicant.
ApplicantCode	String	Code of the applicant.
ApplicantName	String	Proxy id of the applicant.
ApplicantProxyId	Int	Proxy code of the applicant.
ApplicantProxyCode	String	Proxy name of the applicant.
ApplicantProxyName	String	Name of the applicant.
FormId	Int	Id of the form.
FormName	String	Name of the form.

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
ApprovedAt	Datetime	Specify the final approval date and time in RFC3339 format. Supported operators are =,<,>,<=,>=.

Query information regarding request steps.

Select

The Sync App will use the Garoon 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.

• FormId supports = operator.
• StatusType supports = and IN operators.
• ApprovedAt supports <, <=, =, >= and > operators.

For example, the following query is processed server side:

SELECT * FROM RequestSteps WHERE FormId = 3
SELECT * FROM RequestSteps WHERE StatusType = 'REJECTED'
SELECT * FROM RequestSteps WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM RequestSteps WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM RequestSteps WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

Name	Type	Description
RequestId	Int	Id of the request.
FormId	Int	Form id of the request.
StatusType	String	Status of the request.
StepId [KEY]	Int	Id of the step.
StepName	String	Name of the step.
IsApprovalStep	Boolean	Weather the step is approval.
Requirement	String	Requirement.

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
ApprovedAt	Datetime	Specify the final approval date and time in RFC3339 format. Supported operators are =,<,>,<=,>=.

Query information regarding users.

View Specific Information

Garoon does not support any column for filtering this view. All filters will be executed client side.

Columns

Name	Type	Description
Id [KEY]	Int	Id of the user.
Name	String	Name of the user.
Code	String	Code of the user.

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

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

Authentication

---

Property	Description
URL	The URL of the Garoon account.
User	The Garoon user account used to authenticate.
Password	The password used to authenticate the user.
BasicAuthUser	The additional username required for domains using basic authentication.
BasicAuthPassword	The additional password required for domains using basic authentication.

SSL

---

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	The password for the TLS/SSL client certificate.
SSLClientCertSubject	The subject of the TLS/SSL client certificate.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Garoon.
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.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

---

Property	Description
URL	The URL of the Garoon account.
User	The Garoon user account used to authenticate.
Password	The password used to authenticate the user.
BasicAuthUser	The additional username required for domains using basic authentication.
BasicAuthPassword	The additional password required for domains using basic authentication.

The URL of the Garoon account.

Remarks

The URL of the Garoon account in the form 'https://cyp344.cybozu.com'.

The Garoon user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the Garoon server.

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

The additional username required for domains using basic authentication.

Remarks

The basic authentication username, used to connect to basic-authentication-enabled domains. Together with BasicAuthPassword, this field is used to provide authentication for the user to Garoon's servers.

The additional password required for domains using basic authentication.

Remarks

The basic authentication password, used to connect to basic-authentication-enabled domains. Together with BasicAuthUser, this field is used to provide authentication for the user to Garoon's servers.

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

---

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	The password for the TLS/SSL client certificate.
SSLClientCertSubject	The subject of the TLS/SSL client certificate.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

Remarks

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).

The type of key store containing the TLS/SSL client certificate.

Remarks

This property can take one of the following values:

USER - default	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.

The password for the TLS/SSL client certificate.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

The subject of the TLS/SSL client certificate.

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, [email protected]". The common fields and their meanings are shown below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

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

Remarks

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

This property can take the following forms:

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

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

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

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

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Garoon and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

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

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

Remarks

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

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

The TCP port for a proxy-based firewall.

Remarks

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

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

Remarks

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

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

Remarks

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

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

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

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

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

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

Remarks

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

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

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

The TCP port the ProxyServer proxy is running on.

Remarks

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

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

Remarks

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

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

The authentication type can be one of the following:

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

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

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

Remarks

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

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

user@domain
domain\user

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

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

See the Logging page for an overview.

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

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

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

Remarks

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

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

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

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

Remarks

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

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

Remarks

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

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

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

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

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

Remarks

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

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

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

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

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

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Garoon.
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.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

Remarks

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

These hidden properties are used only in specific use cases.

Remarks

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

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

Remarks

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

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

Remarks

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

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

Remarks

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

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

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

Remarks

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

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

This User Defined View configuration file is formatted as follows:

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

For example:

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

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

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

Note that the specified path is not embedded in quotation marks.