Garoon Connector for CData Sync

Build 25.0.9539
  • Garoon
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Events
        • NotificationItems
        • UserPresence
      • Views
        • EventAttachments
        • EventAttendees
        • EventFacilities
        • EventWatchers
        • Facilities
        • FacilityGroups
        • Files
        • Organizations
        • OrganizationUsers
        • RequestItems
        • Requests
        • RequestSteps
        • Users
      • Stored Procedures
        • DownloadFile
    • Connection String Options
      • Authentication
        • URL
        • User
        • Password
        • BasicAuthUser
        • BasicAuthPassword
      • SSL
        • SSLClientCert
        • SSLClientCertType
        • SSLClientCertPassword
        • SSLClientCertSubject
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • Timeout
        • UserDefinedViews
    • Third Party Copyrights

Garoon Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Garoon data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Garoon connector can be used from the CData Sync application to pull data from Garoon and move it to any of the supported destinations.

Garoon Version Support

The Sync App leverages the Garoon API to enable bidirectional access to Garoon.

Garoon Connector for CData Sync

Establishing a Connection

Adding a Connection to Garoon

To add a connection to Garoon:

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

For required properties, see the Settings tab.

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

Connecting to Garoon

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

  • URL: The URL of your account.

NOTE: Here are accepted URL format for supported versions:

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

Authenticating to Garoon

Garoon supports the following authentication methods.

Password

You must set the following to authenticate to Garoon:

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

Additional Security

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

Basic

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

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

Client SSL

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

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

Garoon Connector for CData Sync

Advanced Features

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

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

For further information, see Query Processing.

Logging

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

Garoon Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Client SSL Certificates

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

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

Garoon Connector for CData Sync

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 Sync App uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

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

Garoon Connector for CData Sync

Data Model

Overview

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

Key Features

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

Tables

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

Views

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

Stored Procedures

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

Garoon Connector for CData Sync

Tables

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

Garoon Connector for CData Sync Tables

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

Garoon Connector for CData Sync

Events

Query, create, modify, and delete regarding events.

Select

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

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

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

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

Update

Columns with ReadOnly false can be updated.

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

Using temporary tables:

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

Using aggregates:

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

Insert

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

Using temporary tables:

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

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

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

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

Using aggregates:

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

Delete

Events can be deleted by providing Id of the event.

DELETE FROM Events WHERE Id = 34

Columns

Name Type ReadOnly Description
Id [KEY] String True

Composed id of the event.

EventId Int True

Id of the event.

CreatorId Int True

Id of the creator.

CreatorCode String True

Code of the creator.

CreatorName String True

Name of the creator.

CreatedAt Datetime True

Created time.

UpdaterId Int True

Id of the updater.

UpdaterCode String True

Code of the updater.

UpdaterName String True

Name of the updater.

UpdatedAt Datetime True

Updated time.

EventType String False

Type of the event.

EventMenu String False

Menu of the event.

Subject String False

Subject of the event.

Notes String False

Notes of the event.

VisibilityType String False

Type of visibility.

UseAttendanceCheck Boolean False

Use attendance check.

Attachments String True

Attachments of the event.

Attendees String False

Attendees of the event.

AttendeesCandidate String True

Attendees candidate of the event.

CompanyInfoName String False

Name of company.

CompanyInfoZipCode String False

Zip code of company.

CompanyInfoAddress String False

Address of company.

CompanyInfoRoute String False

Route of company.

CompanyInfoRouteTime String False

Route time of company.

CompanyInfoRouteFare String False

Route fare of company.

CompanyInfoPhone String False

Phone number of company.

StartDateTime Datetime False

Time when event started.

StartTimeZone String False

Starting time zone.

EndDateTime Datetime False

Time when event ends.

EndTimeZone String False

Ending time zone.

IsAllDay Boolean False

When set to true, event is all day.

IsStartOnly Boolean False

When set to true,event is start only.

OriginalStartTimeZone String True

Original start time zone.

OriginalEndTimeZone String True

Original end time zone.

Watchers String False

Watchers of the event.

WatchersCandidate String True

Watchers candidate of the event.

Facilities String False

Facilities of the event.

FacilitiesCandidate String True

Facilities candidate of the event.

FacilityUsingPurpose String False

Facility using purpose

FacilityReservationInfo String True

Facility reservation info.

FacilityUsageRequests String True

Facility usage requests.

RepeatInfo String True

Repeat info.

TemporaryEventCandidates String True

Temporary event candidates.

RepeatId String True

Repeat id.

Pseudo-Columns

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

Name Type Description
DateTime Datetime

Specify the date and time of the search target in RFC3339 format. Supported operators are =,<,>,<=,>=.

TargetType String

Specify the type to narrow down the results by user, organization or facility.

The allowed values are user, organization, facility.

Target String

Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Garoon Connector for CData Sync

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 True

Garoon notification key.

ModuleId [KEY] String True

Garoon module ID.

CreatorId Int True

Garoon user ID of the creator of the notification.

CreatorCode String True

Garoon user name of the creator of the notification.

CreatorName String True

Garoon user login name of the creator of the notification.

CreatedAt Datetime True

Notification creation date and time.

Operation String True

Summary of notification operations.You can specify one of the following three values:add,modify,remove.

Url String True

URL included in the notification.

Title String True

Notification title.

Body String True

Notification text.

Icon String True

Notification icon. A sample icon or URI can be specified.

IsRead Boolean True

Whether the notification has been read.

Pseudo-Columns

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

Name Type Description
Destinations String

List of notification destinations. This column is used for insert and does not return data.

App String

Specify the external notification code set in Garoon's application management.

Garoon Connector for CData Sync

UserPresence

Query, modify regarding presence users.

Select

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the = operator.
  • Code supports the = operator.
For example, the following query is processed server side:
SELECT * FROM UserPresence WHERE Id = 24 
SELECT * FROM UserPresence WHERE Code = 'admin'

Update

Columns with ReadOnly false can be updated.

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

Columns

Name Type ReadOnly Description
Id [KEY] Int True

Garoon user ID

Name String True

Garoon user display name

Code String True

Garoon user login name

UpdatedAt Datetime True

Update time of presence information.The format is ISO8601 UTC time zone.

Notes String False

Memo.

StatusCode String False

Status code of presence information

StatusName String True

Status name of presence information.

Garoon Connector for CData Sync

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.

Garoon Connector for CData Sync Views

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

Garoon Connector for CData Sync

EventAttachments

Query information regarding event attachments.

View Specific Information

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

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

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

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

Columns

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

Pseudo-Columns

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

Name Type Description
TargetType String Specify the type to narrow down the results by user, organization or facility.

The allowed values are user, organization, facility.

Target String Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Garoon Connector for CData Sync

EventAttendees

Query information regarding event attendees.

View Specific Information

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

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

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

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

Columns

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

Pseudo-Columns

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

Name Type Description
TargetType String Specify the type to narrow down the results by user, organization or facility.

The allowed values are user, organization, facility.

Target String Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Garoon Connector for CData Sync

EventFacilities

Query information regarding event facilities.

View Specific Information

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

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

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

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

Columns

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

Pseudo-Columns

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

Name Type Description
TargetType String Specify the type to narrow down the results by user, organization or facility.

The allowed values are user, organization, facility.

Target String Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Garoon Connector for CData Sync

EventWatchers

Query information regarding event watchers.

View Specific Information

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

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

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

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

Columns

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

Pseudo-Columns

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

Name Type Description
TargetType String Specify the type to narrow down the results by user, organization or facility.

The allowed values are user, organization, facility.

Target String Specify the ID to narrow down the results by user Id, organization Id or facility Id.

Garoon Connector for CData Sync

Facilities

Query information regarding facilities.

Select

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports ORDER BY operator.
  • FacilityGroupId supports = operator.
For example, the following queries are processed server side:
SELECT * FROM Facilities ORDER BY id
SELECT Code FROM Facilities
SELECT Id, Subject FROM Events ORDER BY startDateTime DESC LIMIT 2
SELECT * FROM Facilities WHERE FacilityGroupId = 1

Columns

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

Garoon Connector for CData Sync

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.

Garoon Connector for CData Sync

Files

Query information regarding files in a Request.

Select

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports = operator.
For example, the following query is processed server side:
SELECT * FROM Files WHERE Id = 1

Columns

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

Garoon Connector for CData Sync

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.

Garoon Connector for CData Sync

OrganizationUsers

Query information regarding organization users.

Select

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • OrganizationId supports the = operator.
For example, the following query is processed server side:
SELECT OrganizationId, UserId FROM OrganizationUsers WHERE OrganizationId = 24 

Columns

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

Garoon Connector for CData Sync

RequestItems

Query information regarding request items.

Select

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • FormId supports = operator.
  • StatusType supports = and IN operators.
  • ApprovedAt supports <, <=, =, >= and > operators.
For example, the following query is processed server side:
SELECT * FROM RequestItems WHERE FormId = 3
SELECT * FROM RequestItems WHERE StatusType = 'REJECTED'
SELECT * FROM RequestItems WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM RequestItems WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM RequestItems WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

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

Pseudo-Columns

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

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

Garoon Connector for CData Sync

Requests

Query information regarding requests.

Select

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • FormId supports = operator.
  • StatusType supports = and IN operators.
  • ApprovedAt supports <, <=, =, >= and > operators.
For example, the following query is processed server side:
SELECT * FROM Requests WHERE FormId = 3
SELECT * FROM Requests WHERE StatusType = 'REJECTED'
SELECT * FROM Requests WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM Requests WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM Requests WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

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

Pseudo-Columns

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

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

Garoon Connector for CData Sync

RequestSteps

Query information regarding request steps.

Select

The Sync App will use the Garoon API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • FormId supports = operator.
  • StatusType supports = and IN operators.
  • ApprovedAt supports <, <=, =, >= and > operators.
For example, the following query is processed server side:
SELECT * FROM RequestSteps WHERE FormId = 3
SELECT * FROM RequestSteps WHERE StatusType = 'REJECTED'
SELECT * FROM RequestSteps WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM RequestSteps WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM RequestSteps WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

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

Pseudo-Columns

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

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

Garoon Connector for CData Sync

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.

Garoon Connector for CData Sync

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App 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.

Garoon Connector for CData Sync Stored Procedures

Name Description

Garoon Connector for CData Sync

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.

Garoon Connector for CData Sync

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


PropertyDescription
URLThe URL of the Garoon account.
UserSpecifies the authenticating user's user ID.
PasswordSpecifies the authenticating user's password.
BasicAuthUserThe additional username required for domains using basic authentication.
BasicAuthPasswordThe additional password required for domains using basic authentication.

SSL


PropertyDescription
SSLClientCertSpecifies 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.
SSLClientCertTypeSpecifies 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.
SSLClientCertPasswordSpecifes 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.
SSLClientCertSubjectSpecifes 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.
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


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

Schema


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

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Garoon.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
Garoon Connector for CData Sync

Authentication

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


PropertyDescription
URLThe URL of the Garoon account.
UserSpecifies the authenticating user's user ID.
PasswordSpecifies the authenticating user's password.
BasicAuthUserThe additional username required for domains using basic authentication.
BasicAuthPasswordThe additional password required for domains using basic authentication.
Garoon Connector for CData Sync

URL

The URL of the Garoon account.

Remarks

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

Garoon Connector for CData Sync

User

Specifies the authenticating user's user ID.

Remarks

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

Garoon Connector for CData Sync

Password

Specifies the authenticating user's password.

Remarks

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

Garoon Connector for CData Sync

BasicAuthUser

The additional username required for domains using basic authentication.

Remarks

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

Garoon Connector for CData Sync

BasicAuthPassword

The additional password required for domains using basic authentication.

Remarks

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

Garoon Connector for CData Sync

SSL

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


PropertyDescription
SSLClientCertSpecifies 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.
SSLClientCertTypeSpecifies 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.
SSLClientCertPasswordSpecifes 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.
SSLClientCertSubjectSpecifes 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.
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Garoon Connector for CData Sync

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.

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware 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.

Garoon Connector for CData Sync

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.

Remarks

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

USER - defaultFor Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
MACHINEFor Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILEThe certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILEThe certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
PEMKEY_FILEThe certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOBThe certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILEThe certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILEThe certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILEThe certificate store is the name of a PKCS7 file containing certificates.
PPKFILEThe certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILEThe certificate store is the name of a file that contains a certificate in XML format.
XMLBLOBThe certificate store is a string that contains a certificate in XML format.
BCFKSFILEThe certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOBThe certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

Garoon Connector for CData Sync

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.

Remarks

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

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

Garoon Connector for CData Sync

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.

Remarks

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

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Garoon Connector for CData Sync

SSLServerCert

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

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.

Garoon Connector for CData Sync

Firewall

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


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Garoon Connector for CData Sync

FirewallType

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

Remarks

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

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

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

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

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

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

Garoon Connector for CData Sync

FirewallServer

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

Remarks

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

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

Garoon Connector for CData Sync

FirewallPort

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

Remarks

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

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

Garoon Connector for CData Sync

FirewallUser

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

Remarks

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

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

Garoon Connector for CData Sync

FirewallPassword

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

Remarks

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

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

Garoon Connector for CData Sync

Proxy

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


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Garoon Connector for CData Sync

ProxyAutoDetect

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

Remarks

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

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

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

Garoon Connector for CData Sync

ProxyServer

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

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Garoon Connector for CData Sync

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Garoon Connector for CData Sync

ProxyAuthScheme

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

Remarks

Supported authentication types :

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

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

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

Garoon Connector for CData Sync

ProxyUser

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

Remarks

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

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

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

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

Garoon Connector for CData Sync

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

Garoon Connector for CData Sync

ProxySSLType

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

Remarks

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

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

Garoon Connector for CData Sync

ProxyExceptions

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

Remarks

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

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

Garoon Connector for CData Sync

Logging

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


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Garoon Connector for CData Sync

LogModules

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

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name Module Description Submodules
INFO General Information. Includes the connection string, product version (build number), and initial connection messages.
  • Connec – Information related to creating or destroying connections.
  • Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.
  • Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance.
  • Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user).
  • Page – Messages related to query paging.
  • Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.
  • KERB – HTTP requests related to Kerberos.
  • Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product.
  • Res – Messages containing HTTP responses.
  • Req – Messages containing HTTP requests.
WSDL Messages pertaining to the generation of WSDL/XSD files. —
SSL SSL certificate messages.
  • Certif – Messages pertaining to SSL certificates.
AUTH Authentication related failure/success messages.
  • Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • OAuth – Messages related to OAuth authentication.
  • Krbros – Kerberos-related authentication messages.
SQL Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.
  • Bulk – Messages pertaining to bulk query execution.
  • Cache – Messages related to reading row data from and writing row data to the product's cache for better performance.
  • Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • ResSet – Query resultsets.
  • Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META Metadata cache and schema messages.
  • Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance.
  • Schema – Messages related to retrieving metadata from or modifying the service schema.
  • MemSto – Messages related to writing to or reading from in-memory metadata cache.
  • Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC Information related to executing SQL functions.
  • Errmsg – Error messages related to executing SQL functions.
TCP Incoming and outgoing raw bytes on TCP transport layer messages.
  • Send – Raw data sent via the TCP protocol.
  • Receiv – Raw data received via the TCP protocol.
FTP Messages pertaining to the File Transfer Protocol.
  • Info – Status messages related to communication in the FTP protocol.
  • Client – Messages related to actions taken by the FTP client (the product) during FTP communication.
  • Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP Messages pertaining to the Secure File Transfer Protocol.
  • Info – Status messages related to communication in the SFTP protocol.
  • To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication.
  • From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP Messages pertaining to data transferred via the Post Office Protocol.
  • Client – Messages related to actions taken by the POP client (the product) during POP communication.
  • Server – Messages related to actions taken by the POP server during POP communication.
  • Status – Status messages related to communication in the POP protocol.
SMTP Messages pertaining to data transferred via the Simple Mail Transfer Protocol.
  • Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication.
  • Server – Messages related to actions taken by the SMTP server during SMTP communication.
  • Status – Status messages related to communication in the SMTP protocol.
CORE Messages relating to various internal product operations not covered by other modules. —
DEMN Messages related to SQL remoting. —
CLJB Messages about bulk data uploads (cloud job).
  • Commit – Submissions for bulk data uploads.
SRCE Miscellaneous messages produced by the product that don't belong in any other module. —
TRANCE Advanced messages concerning low-level product operations. —

Garoon Connector for CData Sync

Schema

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


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Garoon Connector for CData Sync

Location

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

Remarks

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

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

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

Garoon Connector for CData Sync

BrowsableSchemas

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

Remarks

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

Garoon Connector for CData Sync

Tables

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

Remarks

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

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

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

Garoon Connector for CData Sync

Views

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

Remarks

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

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

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

Garoon Connector for CData Sync

Miscellaneous

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


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Garoon.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
Garoon Connector for CData Sync

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

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

Garoon Connector for CData Sync

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

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

Integration and Formatting

PropertyDescription
DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=TrueConverts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Garoon Connector for CData Sync

Pagesize

Specifies the maximum number of records per page the provider returns when requesting data from Garoon.

Remarks

When processing a query, instead of requesting all of the queried data at once from Garoon, the Sync App can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Sync App requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.

Garoon Connector for CData Sync

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

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

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Garoon Connector for CData Sync

Timeout

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

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.

Garoon Connector for CData Sync

UserDefinedViews

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

Remarks

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

For example:

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

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json
When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

Garoon Connector for CData Sync

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

All rights reserved.

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.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539