Getting Started

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

Connecting to Garoon

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

Accessing Data from CData Cloud Services

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

Establishing a Connection

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

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

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud 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 Cloud 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.

Firewall and Proxy

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

Data Model

Overview

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

Key Features

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

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.

Tables

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

CData Cloud - Garoon Tables


Name	Description
AdminFacilities	Query, create, update, and delete facilities using administrator privileges.
AdminFacilityGroups	Query, create, update, and delete facility groups using administrator privileges.
Discussions	Query and create discussions in a space.
Events	Query, create, modify, and delete regarding events.
Messages	Query and create regarding messages.
NotificationItems	Query, create, modify regarding notification items.
SpaceFiles	Query and delete space attachment files. The Id column is required for querying.
ToDo	Query and create to-do items.
UserPresence	Query, modify regarding presence users.

AdminFacilities

Query, create, update, and delete facilities using administrator privileges.

Table-Specific Information

SELECT

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

Id supports the '=,IN' operators.
Name supports the '=' operator.
NameLocaleJa supports the '=' operator.
NameLocaleEn supports the '=' operator.
NameLocaleZh supports the '=' operator.
NameLocaleZhTw supports the '=' operator.
Code supports the '=,IN' operators.
Notes supports the '=' operator.
FacilityGroupId supports the '=,IN' operators.

For example, the following queries are processed server-side while other filters are processed client-side within the Cloud.

SELECT * FROM AdminFacilities WHERE Id = 7
SELECT * FROM AdminFacilities WHERE Id IN (1, 2, 3, 4)
SELECT * FROM AdminFacilities WHERE Name = 'Jeremiah'
SELECT * FROM AdminFacilities WHERE NameLocaleJa = '会議室A'
SELECT * FROM AdminFacilities WHERE NameLocaleEn = 'Meeting room A'
SELECT * FROM AdminFacilities WHERE NameLocaleZh = '会议室A'
SELECT * FROM AdminFacilities WHERE NameLocaleZhTw = '會議室A'
SELECT * FROM AdminFacilities WHERE Code = 'meeting_room_a'
SELECT * FROM AdminFacilities WHERE Code IN ('meeting_room_a', 'meeting_room_b')
SELECT * FROM AdminFacilities WHERE Notes = 'This is note'
SELECT * FROM AdminFacilities WHERE FacilityGroupId = 1
SELECT * FROM AdminFacilities WHERE FacilityGroupId IN (1, 2)

INSERT

The Name and Code columns are required for Insert:

INSERT INTO AdminFacilities(Name, NameLocaleEn, NameLocaleZh, Code, FacilityGroupId) VALUES('GaroonAdmin', 'US', 'RJ', 'GAdmin', 5)

UPDATE

You must specify the Id of the AdminFacilities to update it. Columns with ReadOnly false can be updated.

UPDATE AdminFacilities SET Name = 'Brian' WHERE Id = 10

DELETE

You must specify the Id of the AdminFacilities to delete it.

DELETE FROM AdminFacilities WHERE Id = 9

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Id of the facility.
Name	String	False	Name of the facility.
NameLocaleJa	String	False	Japanese display name of the facility.
NameLocaleEn	String	False	English display name of the facility.
NameLocaleZh	String	False	Simplified Chinese display name of the facility.
NameLocaleZhTw	String	False	Traditional Chinese display name of the facility.
Code	String	False	Code of the facility.
Notes	String	False	Notes of the facility.
FacilityGroupId	Int	False	Id of the facility group the facility belongs to.

AdminFacilityGroups

Query, create, update, and delete facility groups using administrator privileges.

Table-Specific Information

SELECT

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

Id supports the '=,IN' operators.
Name supports the '=' operator.
NameLocaleJa supports the '=' operator.
NameLocaleEn supports the '=' operator.
NameLocaleZh supports the '=' operator.
NameLocaleZhTw supports the '=' operator.
Code supports the '=,IN' operators.
Notes supports the '=' operator.
ParentFacilityGroupId supports the '=,IN' operators.

For example, the following queries are processed server-side while other filters are processed client-side within the Cloud.

SELECT * FROM AdminFacilityGroups WHERE Id = 7
SELECT * FROM AdminFacilityGroups WHERE Id IN (1, 2, 3, 4)
SELECT * FROM AdminFacilityGroups WHERE Name = 'Benzamin'
SELECT * FROM AdminFacilityGroups WHERE NameLocaleJa = '会議室A'
SELECT * FROM AdminFacilityGroups WHERE NameLocaleEn = 'Meeting room A'
SELECT * FROM AdminFacilityGroups WHERE NameLocaleZh = '会议室A'
SELECT * FROM AdminFacilityGroups WHERE NameLocaleZhTw = '會議室A'
SELECT * FROM AdminFacilityGroups WHERE Code = 'meeting_room_a'
SELECT * FROM AdminFacilityGroups WHERE Code IN ('meeting_room_a', 'meeting_room_b')
SELECT * FROM AdminFacilityGroups WHERE Notes = 'This is note'
SELECT * FROM AdminFacilityGroups WHERE ParentFacilityGroupId = 1
SELECT * FROM AdminFacilityGroups WHERE ParentFacilityGroupId IN (1, 2)

INSERT

The Name and Code columns are required for Insert:

INSERT INTO AdminFacilityGroups(Name, NameLocaleEn, NameLocaleZh, Code, ParentFacilityGroupId) VALUES('Benzamin', 'US', 'RJ', 'GAdmin', 1)

UPDATE

You must specify the Id of the AdminFacilityGroups to update it. Columns with ReadOnly false can be updated.

UPDATE AdminFacilityGroups SET Name = 'Brian' WHERE Id = 10

DELETE

You must specify the Id of the AdminFacilityGroups to delete it.

DELETE FROM AdminFacilityGroups WHERE Id = 9

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	True	Id of the facility group.
Name	String	False	Name of the facility group.
NameLocaleJa	String	False	Japanese display name of the facility group.
NameLocaleEn	String	False	English display name of the facility group.
NameLocaleZh	String	False	Simplified Chinese display name of the facility group.
NameLocaleZhTw	String	False	Traditional Chinese display name of the facility group.
Code	String	False	Code of the facility group.
Notes	String	False	Notes of the facility group.
ParentFacilityGroupId	Int	False	Id of the parent facility group.
ChildFacilityGroups	String	True	Child facility groups of the facility group.

Discussions

Query and create discussions in a space.

Select

The Cloud uses 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 Cloud.

SpaceId supports the '=' operator and is required for querying.

For example, the following query is processed server side:

SELECT * FROM Discussions WHERE SpaceId = 3

Insert

To create a Discussion, you must specify the SpaceId and Title fields.

INSERT INTO Discussions (SpaceId, Title) VALUES (3, 'New Discussion')

Discussion with body content:

INSERT INTO Discussions (SpaceId, Title, Body) VALUES (3, 'New Discussion', 'This is the body of the discussion.')

Discussion with HTML body:

INSERT INTO Discussions (SpaceId, Title, Body, IsHtmlBody) VALUES (3, 'HTML Discussion', 'This is HTML body', true)

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	ID of the discussion.
SpaceId	String	False	ID of the space.
Title	String	False	Title of the discussion.
Body	String	False	Body of the discussion.
IsHtmlBody	Boolean	False	Whether body is HTML format.
CreatedAt	Datetime	True	Creation date and time.
CreatorId	String	True	Creator's Garoon user ID.
CreatorCode	String	True	Creator's login name.
CreatorName	String	True	Creator's display name.
UpdatedAt	Datetime	True	Update date and time.
UpdaterId	String	True	Updater's Garoon user ID.
UpdaterCode	String	True	Updater's login name.
UpdaterName	String	True	Updater's display name.

Events

Query, create, modify, and delete regarding events.

Select

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

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

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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.

Messages

Query and create regarding messages.

Select

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

Id supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM Messages WHERE Id = 3

Insert

To add a Message, you must specify the Title and Recipients fields. The Title has a maximum of 100 characters.

Basic message creation:

INSERT INTO Messages (Title, Recipients) VALUES ('This is title of updated message', '[{"id":1,"type":"USER"}]')

Message with body content:

INSERT INTO Messages (Title, Recipients, Body, Acknowledgement, IsDraft)
VALUES ('This is title of message', '[{"id":1,"type":"USER"}]', 'This is body of the message.', true, false)

Message with HTML body and operator permissions:

INSERT INTO Messages (Title, Recipients, Body, IsHtmlBody, OperatorType, Operators)
VALUES ('HTML Message', '[{"id":1,"type":"USER"}]', 'This is HTML body', true, 'SELECT_USERS', '[{"id":2,"type":"USER"}]')

Draft message creation:

INSERT INTO Messages (Title, Recipients, Body, IsDraft)
VALUES ('Draft Message', '[{"id":1,"type":"USER"}]', 'Draft content', true)

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Message ID.
Title	String	False	Message title.
CreatorId	String	True	Creator's Garoon user ID.
CreatorCode	String	True	Creator's login name.
CreatorName	String	True	Creator's display name.
CreatedAt	Datetime	True	Creation date and time.
UpdaterId	String	True	Updater's Garoon user ID.
UpdaterCode	String	True	Updater's login name.
UpdaterName	String	True	Updater's display name.
UpdatedAt	Datetime	True	Update date and time.
Acknowledgement	Boolean	False	Whether to check reading status.
IsDraft	Boolean	False	Whether message is draft.
Body	String	False	Message body.
IsHtmlBody	Boolean	False	Whether body is HTML format.
OperatorType	String	False	Change/delete permission type.
Recipients	String	False	Message recipients.
Folders	String	True	Message folders.
Operators	String	False	Users allowed to change/delete message.

NotificationItems

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	False	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	False	Summary of notification operations.You can specify one of the following three values:add,modify,remove.
Url	String	False	URL included in the notification.
Title	String	False	Notification title.
Body	String	False	Notification text.
Icon	String	False	Notification icon. A sample icon or URI can be specified.
IsRead	Boolean	True	Whether the notification has been read.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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.

SpaceFiles

Query and delete space attachment files. The Id column is required for querying.

Select

The Cloud uses 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 Cloud.

Id supports the '=' operator and is required for querying.

For example, the following query is processed server side:

SELECT * FROM SpaceFiles WHERE Id = 3

Delete

Space attachment files can be deleted by providing the Id of the file.

DELETE FROM SpaceFiles WHERE Id = 3

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	ID of the attachment file.
ContentType	String	True	MIME type of the file.
Name	String	True	Name of the file.
Size	Long	True	Size of the file in bytes.
Content	String	True	Base64-encoded content of the file.

ToDo

Query and create to-do items.

Select

The Cloud uses 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 Cloud.

Id supports the '=' operator and is required for querying.

For example, the following query is processed server side:

SELECT * FROM ToDo WHERE Id = 3

Insert

To create a ToDo item, you must specify the Subject field.

INSERT INTO ToDo (Subject) VALUES ('New task')

ToDo with category, due date, priority, and notes:

INSERT INTO ToDo (Subject, CategoryId, DueDate, Priority, Notes) VALUES ('New task', 1, '2026-12-31T17:00:00Z', 2, 'Follow up before EOY')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	True	ID of the to-do item.
Status	String	True	Status of the to-do. One of: Completed, Uncompleted.
CategoryId	Int	False	ID of the category.
Subject	String	False	Subject of the to-do item.
HasDueDate	Boolean	True	Whether a due date is set.
DueDate	Datetime	False	Due date of the to-do item.
Priority	Int	False	Priority of the to-do item. One of: 1, 2, 3.
Notes	String	False	Notes for the to-do item.

UserPresence

Query, modify regarding presence users.

Select

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

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

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Garoon Views


Name	Description
BulletinCategories	Query bulletin board categories.
BulletinCategoryTopics	Query bulletin board topics within a category.
BulletinTopics	Query bulletin board topics by ID. The Id column is required for querying.
BulletinTopicsDraft	Query bulletin board draft topics by ID. The Id column is required for querying.
DiscussionAttachments	Query a list of attachments for a discussion.
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.
MessageAttachments	Query information regarding message attachments.
MessageList	Query information regarding messages with admin privileges.
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.
SpaceAttachments	Query a list of attachments for a space.
Spaces	Query information regarding spaces.
ToDoCategories	Query to-do categories.
Users	Query information regarding users.

BulletinCategories

Query bulletin board categories.

Select

Garoon does not support any column for filtering this table. All filters are executed client side.

Columns


Name	Type	Description
Id [KEY]	String	ID of the bulletin category.
Name	String	Name of the bulletin category.
Description	String	Description of the bulletin category.
HasSubCategories	Boolean	Whether the category has sub-categories.

BulletinCategoryTopics

Query bulletin board topics within a category.

Select

The Cloud uses 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 Cloud.

CategoryId supports the '=' operator and is required for querying.

For example, the following query is processed server side:

SELECT * FROM BulletinCategoryTopics WHERE CategoryId = 1

Columns


Name	Type	Description
Id [KEY]	String	ID of the bulletin topic.
CategoryId [KEY]	String	ID of the bulletin category to retrieve topics for.
Subject	String	Subject of the bulletin topic.
UpdatedAt	Datetime	Update date and time.
UpdaterId	String	Updater's Garoon user ID.
UpdaterCode	String	Updater's login name.
UpdaterName	String	Updater's display name.
ManuallySender	String	Manually entered sender name.

BulletinTopics

Query bulletin board topics by ID. The Id column is required for querying.

Select

The Cloud uses 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 Cloud.

Id supports the '=' operator and is required for querying.

For example, the following query is processed server side:

SELECT * FROM BulletinTopics WHERE Id = 3

Columns


Name	Type	Description
Id [KEY]	String	ID of the bulletin topic.
Subject	String	Subject of the bulletin topic.
CategoryId	String	ID of the category.
CategoryName	String	Name of the category.
PublicPeriodIsUnlimited	Boolean	Whether the public period is unlimited.
PublicPeriodStart	Datetime	Start of the public period.
PublicPeriodEnd	Datetime	End of the public period.
CreatedAt	Datetime	Creation date and time.
CreatorId	String	Creator's Garoon user ID.
CreatorCode	String	Creator's login name.
CreatorName	String	Creator's display name.
UpdatedAt	Datetime	Update date and time.
UpdaterId	String	Updater's Garoon user ID.
UpdaterCode	String	Updater's login name.
UpdaterName	String	Updater's display name.
Body	String	Body of the bulletin topic.
IsHtmlBody	Boolean	Whether the body is HTML format.
AllowComments	Boolean	Whether comments are allowed.
OperatorType	String	Change or delete permission type.
Operators	String	Users or groups with change or delete permission.
Acknowledgement	Boolean	Whether reading acknowledgement is required.
Attachments	String	Files attached to the bulletin topic.
IsDraft	Boolean	Whether the topic is a draft.
IsPublished	Boolean	Whether the topic has been published.
IsExpired	Boolean	Whether the public period of the topic has expired.

BulletinTopicsDraft

Query bulletin board draft topics by ID. The Id column is required for querying.

Select

The Cloud uses 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 Cloud.

Id supports the '=' operator and is required for querying.

For example, the following query is processed server side:

SELECT * FROM BulletinTopicsDraft WHERE Id = 3

Columns


Name	Type	Description
Id [KEY]	String	ID of the draft topic.
Subject	String	Subject of the draft topic.
CategoryId	String	ID of the category.
CategoryName	String	Name of the category.
PublicPeriodIsUnlimited	Boolean	Whether the public period is unlimited.
PublicPeriodStart	Datetime	Start of the public period.
PublicPeriodEnd	Datetime	End of the public period.
CreatedAt	Datetime	Creation date and time.
CreatorId	String	Creator's Garoon user ID.
CreatorCode	String	Creator's login name.
CreatorName	String	Creator's display name.
UpdatedAt	Datetime	Update date and time.
UpdaterId	String	Updater's Garoon user ID.
UpdaterCode	String	Updater's login name.
UpdaterName	String	Updater's display name.
ManuallySender	String	Manually entered sender name.
Body	String	Body of the draft topic.
IsHtmlBody	Boolean	Whether the body is HTML format.
AllowComments	Boolean	Whether comments are allowed.
OperatorType	String	Change or delete permission type.
Operators	String	Users or groups with change or delete permission.
Acknowledgement	Boolean	Whether reading acknowledgement is required.
Attachments	String	Files attached to the draft topic.
IsDraft	Boolean	Whether the topic is a draft.
IsPublished	Boolean	Whether the topic has been published.
IsExpired	Boolean	Whether the public period of the topic has expired.

DiscussionAttachments

Query a list of attachments for a discussion.

Select

The Cloud uses 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 Cloud.

DiscussionId supports the '=' operator and is required for querying.

For example, the following query is processed server side:

SELECT * FROM DiscussionAttachments WHERE DiscussionId = 3

Columns


Name	Type	Description
Id [KEY]	String	ID of the file.
DiscussionId	String	ID of the discussion to retrieve attachments for.
Name	String	Name of the file.
Size	Long	Size of the file in bytes.
CreatedAt	Datetime	Creation date and time.
UpdatedAt	Datetime	Update date and time.
CreatorId	String	Creator's Garoon user ID.
CreatorCode	String	Creator's login name.
CreatorName	String	Creator's display name.
UpdaterId	String	Updater's Garoon user ID.
UpdaterCode	String	Updater's login name.
UpdaterName	String	Updater's display name.

EventAttachments

Query information regarding event attachments.

View Specific Information

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

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.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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.

EventAttendees

Query information regarding event attendees.

View Specific Information

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

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

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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.

EventFacilities

Query information regarding event facilities.

View Specific Information

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

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.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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.

EventWatchers

Query information regarding event watchers.

View Specific Information

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

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

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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.

Facilities

Query information regarding facilities.

Select

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

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.

FacilityGroups

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.

Files

Query information regarding files in a Request.

Select

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

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.

MessageAttachments

Query information regarding message attachments.

Select

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

MessageId supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM MessageAttachments WHERE MessageId = 3

Columns


Name	Type	Description
MessageId [KEY]	String	Message ID to retrieve attachments for.
Id [KEY]	String	ID of the file.
Name	String	Name of the file.
Size	String	Size of the file.
CreatorId	String	Creator's Garoon user ID.
CreatorName	String	Creator's display name.
CreatorCode	String	Creator's login name.
UpdaterId	String	Updater's Garoon user ID.
UpdaterName	String	Updater's display name.
UpdaterCode	String	Updater's login name.
CreatedAt	Datetime	Creation date and time.
UpdatedAt	Datetime	Update date and time.

MessageList

Query information regarding messages with admin privileges.

Select

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

UpdatedAt supports <, <=, =, >= and > operators.

For example, the following queries are processed server side:

SELECT * FROM MessageList WHERE UpdatedAt >= '2026-02-16 00:00:00.0'
SELECT * FROM MessageList WHERE UpdatedAt = '2026-02-25 05:53:23.0'
SELECT * FROM MessageList WHERE UpdatedAt BETWEEN '2026-02-24 00:00:00.0' AND '2026-02-25 23:59:59.0'
SELECT * FROM MessageList WHERE UpdatedAt > '2026-02-12 01:10:03.0'

Columns


Name	Type	Description
Id [KEY]	String	Message ID.
Subject	String	Message title.
CreatorId	String	Creator's Garoon user ID.
CreatorName	String	Creator's display name.
CreatorCode	String	Creator's login name.
UpdaterId	String	Updater's Garoon user ID.
UpdaterName	String	Updater's display name.
UpdaterCode	String	Updater's login name.
CreatedAt	Datetime	Creation date and time.
UpdatedAt	Datetime	Update date and time.

Organizations

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.

OrganizationUsers

Query information regarding organization users.

Select

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

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

RequestItems

Query information regarding request items.

Select

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

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.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
ApprovedAt	Datetime	Specify the final approval date and time in RFC3339 format. Supported operators are =,<,>,<=,>=.

Requests

Query information regarding requests.

Select

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

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.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
ApprovedAt	Datetime	Specify the final approval date and time in RFC3339 format. Supported operators are =,<,>,<=,>=.

RequestSteps

Query information regarding request steps.

Select

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

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.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
ApprovedAt	Datetime	Specify the final approval date and time in RFC3339 format. Supported operators are =,<,>,<=,>=.

SpaceAttachments

Query a list of attachments for a space.

Select

The Cloud uses 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 Cloud.

SpaceId supports the '=' operator and is required for querying.

For example, the following query is processed server side:

SELECT * FROM SpaceAttachments WHERE SpaceId = 3

Columns


Name	Type	Description
Id [KEY]	String	ID of the file.
SpaceId	String	ID of the space to retrieve attachments for.
Name	String	Name of the file.
Size	Long	Size of the file in bytes.
CreatedAt	Datetime	Creation date and time.
UpdatedAt	Datetime	Update date and time.
CreatorId	String	Creator's Garoon user ID.
CreatorCode	String	Creator's login name.
CreatorName	String	Creator's display name.
UpdaterId	String	Updater's Garoon user ID.
UpdaterCode	String	Updater's login name.
UpdaterName	String	Updater's display name.

Spaces

Query information regarding spaces.

Select

Garoon does not support any column for filtering this table. All filters are executed client side.

Columns


Name	Type	Description
Id [KEY]	String	ID of the space.
Name	String	Name of the space.
IsPublic	Boolean	Whether the space is public.
CategoryId	String	ID of the category.
CategoryName	String	Name of the category.
CreatedAt	Datetime	Creation date and time.
CreatorId	String	Creator's Garoon user ID.
CreatorCode	String	Creator's login name.
CreatorName	String	Creator's display name.
UpdatedAt	Datetime	Update date and time.
UpdaterId	String	Updater's Garoon user ID.
UpdaterCode	String	Updater's login name.
UpdaterName	String	Updater's display name.

ToDoCategories

Query to-do categories.

Select

Garoon does not support any column for filtering this table. All filters are executed client side.

Columns


Name	Type	Description
Id [KEY]	Int	ID of the to-do category.
Name	String	Name of the to-do category.

Users

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.

Stored Procedures

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

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

CData Cloud - Garoon Stored Procedures


Name	Description
AddDiscussionComment	Add a comment to a discussion in a space.
DownloadFile	Download a specified file in a Request.
DownloadMessageAttachment	Download a message attachment file.

AddDiscussionComment

Add a comment to a discussion in a space.

Input


Name	Type	Required	Description
SpaceId	String	True	ID of the space containing the discussion.
DiscussionId	String	True	ID of the discussion to add the comment to.
Body	String	True	Body of the comment.
IsHtmlBody	Boolean	False	Whether the body is HTML format.

Result Set Columns


Name	Type	Description
Status	String	The status of the operation.
Id	String	The unique identifier of the sheet created.

DownloadFile

Download a specified file in a Request.

Input


Name	Type	Required	Description
FileId	String	True	Id of the file.
DownloadLocation	String	False	Location of the downloaded file. Ex- C:\Temp\CompanyFiles
Encoding	String	False	The FileData input encoding type. The allowed values are NONE, BASE64. The default value is BASE64.

Result Set Columns


Name	Type	Description
Success	String	Returns True if the download succeeded.
FileData	String	If the DownloadLocation and FileStream are not provided, this contains the content of the file.

DownloadMessageAttachment

Download a message attachment file.

Input


Name	Type	Required	Description
FileId	String	False	File Id to download.
MessageId	String	False	Message Id to download all the attachments in the Message.
DownloadLocation	String	False	Download location. This is required when MessageId is specified.
Encoding	String	False	The FileData input encoding type. The allowed values are NONE, BASE64. The default value is BASE64.

Result Set Columns


Name	Type	Description
Status	String	The status of the operation.
FileData	String	If the DownloadLocation and FileStream are not provided, this contains the content of the file.

System Tables

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

Schema Tables

The following tables return database metadata for Garoon:

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

Data Source Tables

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

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

Query Information Tables

The following table returns query statistics for data modification queries

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


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

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


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

sys_tablecolumns

Describes the columns of the available tables and views.

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

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

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.
ColumnCapabilities	Int32	A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


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

sys_procedureparameters

Describes stored procedure parameters.

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

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Garoon procedure.

Pseudocolumns


Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

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

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

Columns


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

sys_foreignkeys

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


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

sys_primarykeys

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys

Columns


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

sys_indexes

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


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

sys_connection_props

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


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

sys_sqlinfo

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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


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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Columns


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

sys_identity

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity

Columns


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

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

Connection String Options

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

Logging

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

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

Miscellaneous

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Garoon.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Authentication

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

SSL

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.

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.

Data Type

string

Default Value

""

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.

SSLClientCertType

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Logging

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

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

Schema

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

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

BrowsableSchemas

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

Data Type

string

Default Value

""

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.

Miscellaneous

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 number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Garoon.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud 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:

*=*

ThrowsKeyNotFound

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

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.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows 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.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Cloud

Garoon - CData Cloud

Overview

Key Features

Getting Started

Connecting to Garoon

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to Garoon

Authenticating to Garoon

Password

Additional Security

Basic

Client SSL

SSL Configuration

Customizing the SSL Configuration

Client SSL Certificates

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Overview

Key Features

Tables

Views

Stored Procedures

Tables

CData Cloud - Garoon Tables

AdminFacilities

Table-Specific Information

SELECT

INSERT

UPDATE

DELETE

Columns

AdminFacilityGroups

Table-Specific Information

SELECT

INSERT

UPDATE

DELETE

Columns

Discussions

Select

Insert

Columns

Events

Select

Update

Insert

Delete

Columns

Pseudocolumns

Messages

Select

Insert

Columns

NotificationItems

View Specific Information

Upsert

Columns

Pseudocolumns

SpaceFiles

Select

Delete

Columns

ToDo

Select

Insert

Columns

UserPresence

Select

Update

Columns

Views

CData Cloud - Garoon Views

BulletinCategories

Select

Columns