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 supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

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 authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

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.
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	Specifies the user ID of the authenticating Garoon user account.
Password	Specifies the password of the authenticating user account.
BasicAuthUser	The additional username required for domains using basic authentication.
BasicAuthPassword	The additional password required for domains using basic authentication.

SSL

---

Property	Description
SSLClientCert	Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
SSLClientCertType	Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
SSLClientCertPassword	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLClientCertSubject	Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

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

Proxy

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Garoon, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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	Specifies the user ID of the authenticating Garoon user account.
Password	Specifies the password of the authenticating user account.
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'.

Specifies the user ID of the authenticating Garoon user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the password of the authenticating user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

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	Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
SSLClientCertType	Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
SSLClientCertPassword	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLClientCertSubject	Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.

Remarks

This property specifies the client certificate store for SSL Client Authentication. Use this property alongside SSLClientCertType, which defines the type of the certificate store, and SSLClientCertPassword, which specifies the password for password-protected stores. When SSLClientCert is set and SSLClientCertSubject is configured, the driver searches for a certificate matching the specified subject.

Certificate store designations vary by platform. On Windows, certificate stores are identified by names such as MY (personal certificates), while in Java, the certificate store is typically a file containing certificates and optional private keys.

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.

For PFXFile types, set this property to the filename. For PFXBlob types, set this property to the binary contents of the file in PKCS12 format.

Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.

Remarks

This property determines the format and location of the key store used to provide the client certificate. Supported values include platform-specific and universal key store formats. The available values and their usage are:

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.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.

Remarks

This property provides the password needed to open a password-protected certificate store. This property is necessary when using certificate stores that require a password for decryption, as is often recommended for PFX or JKS type stores.

If the certificate store type does not require a password, for example USER or MACHINE on Windows, this property can be left blank. Ensure that the password matches the one associated with the specified certificate store to avoid authentication errors.

Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.

Remarks

This property determines which client certificate to load based on its subject. The Sync App searches for a certificate that exactly matches the specified subject. If no exact match is found, the Sync App looks for certificates containing the value of the subject. If no match is found, no certificate is selected.

The subject should follow the standard format of a comma-separated list of distinguished name fields and values. For example, CN=www.server.com, OU=Test, C=US. Common fields include the following:

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

Note: If any field contains special characters, such as commas, the value must be quoted. For example: CN="Example, Inc.", C=US.

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

Remarks

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

This property can take the following forms:

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

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

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

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

---

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

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

Remarks

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

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

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

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

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Garoon. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Garoon. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Garoon. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

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

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

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

Remarks

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

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

Remarks

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

For other proxy types, see FirewallType.

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

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

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

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

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

---

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

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

Remarks

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

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

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

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

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

---

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

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

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

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

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

Remarks

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

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

Remarks

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

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

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

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

Remarks

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

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

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

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

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Garoon, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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

Remarks

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

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

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

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

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

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

Remarks

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

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

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

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

Remarks

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

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

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

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

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

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.