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

Connecting to Bcart

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

Accessing Data from CData Cloud Services

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

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

Connecting to Bcart

Personal Access Token Authentication

Personal Access Token is required for Bcart driver. After logging in to Bcart API Management page, go to the Application Management, click Create New Token, enter the Name and slelect the necessary permissions. After that you can get the Personal Access Token.
PersonalAccessToken : Set the created Personal Access Token.

OAuth Authentication

To enable this authentication, you must create a custom OAuth application, and set AuthScheme to OAuth.

The following subsections describe how to authenticate to Bcart from three common OAuth authentication flows.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Bcart, see Connection.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token:

1. Before connecting to data for the first time, set these connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id in your custom OAuth application settings.
   • OAuthClientSecret: The client secret in your custom OAuth application settings.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
2. On subsequent data connections, set:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your custom OAuth application settings.
   • OAuthClientSecret: The Client Secret in your custom OAuth application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Creating a Custom OAuth Application

The following procedure creates a custom OAuth application and obtains the OAuth values for your application.

1. Log into the Bcart Developers portal.
2. Click Application Store Management.
3. Click Create.
4. Fill in all required values.
5. Specify a Redirect URL:
   • If you are making a desktop application, enter http://localhost:33333, the Cloud's default. Or set a different port of your choice, and set CallbackURL to this precise URL.
   • If you are making a Web application, set the Redirect URL to a web location where users should return bearing the access token, after they grant permissions to your application.

Save your changes and record your client Id, client secret, and callback URL for future use.

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

Overview

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

Key Features

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

Tables

Tables describes the available tables. Tables are statically defined to model Customers, Orders, Products, and more.

Views

Views describes the available views. Views are statically defined to model PriceGroups, ProductOptions, ShippingGroups, and more.

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

CData Cloud - Bcart Tables

Name	Description
Bookmarks	Usage information for the operation Bookmarks.rsd.
Categories	Usage information for the operation Categories.rsd.
Customers	Usage information for the operation Customers.rsd.
Logistics	Usage information for the operation Logistics.rsd.
OrderProducts	Usage information for the operation OrderProducts.rsd.
Orders	Usage information for the operation Orders.rsd.
OrderStatuses	Usage information for the operation OrderStatuses.rsd.
OtherAddresses	Usage information for the operation OtherAddresses.rsd.
Points	Usage information for the operation Points.rsd.
ProductFeatures	Usage information for the operation ProductFeatures.rsd.
Products	Usage information for the operation Products.rsd.
ProductSets	Usage information for the operation ProductSets.rsd.
ProductStock	Usage information for the operation ProductStock.rsd.

Returns data from Bookmarks table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM Bookmarks WHERE Id = 12345
    SELECT * FROM Bookmarks WHERE CustomerId IN (1, 10)
    SELECT * FROM Bookmarks WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

To add a Bookmarks, specify CustomerId, ProductId and the non-read-only columns.

    INSERT INTO Bookmarks (CustomerId, ProductId) VALUES (12345, 12345)

Bulk Insert

    INSERT INTO Bookmarks#TEMP (CustomerId, ProductId) VALUES (12345, 12345)
    INSERT INTO Bookmarks#TEMP (CustomerId, ProductId) VALUES (12345, 12345)
    INSERT INTO Bookmarks (CustomerId, ProductId) SELECT CustomerId, ProductId FROM Bookmarks#TEMP

Update

Bcart allows updates for CustomerId, ProductId and the non-read-only columns.

    UPDATE Bookmarks SET CustomerId = 12345 WHERE Id = 12345

Bulk Update

    INSERT INTO Bookmarks#TEMP (Id, CustomerId, ProductId) VALUES (1, 12345, 12345)
    INSERT INTO Bookmarks#TEMP (Id, CustomerId, ProductId) VALUES (2, 12345, 12345)
    UPDATE Bookmarks (Id, CustomerId, ProductId) SELECT Id, CustomerId, ProductId FROM Bookmarks#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
CustomerId	Integer	False
ProductId	Integer	False
UpdatedAt	Datetime	False

Returns data from Categories table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM Categories WHERE Name = 'Sample Category'
    SELECT * FROM Categories WHERE Id IN (1, 10)
    SELECT * FROM Categories WHERE Priority <= 5

Insert

To add a Categories, specify Name and the non-read-only columns.

    INSERT INTO Categories (Name) VALUES ('Sample Category')

Bulk Insert

    INSERT INTO Categories#TEMP (Name) VALUES ('Sample Category 1')
    INSERT INTO Categories#TEMP (Name) VALUES ('Sample Category 2')
    INSERT INTO Categories (Name) SELECT Name FROM Categories#TEMP

Update

Bcart allows updates for Name, Description and the non-read-only columns.

    UPDATE Categories SET Name = 'Sample Category' WHERE Id = 2

Bulk Update

    INSERT INTO Categories#TEMP (Id, Name) VALUES (1, 'Sample Category 1')
    INSERT INTO Categories#TEMP (Id, Name) VALUES (2, 'Sample Category 2')
    UPDATE Categories (Id, Name) SELECT Id, Name FROM Categories#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
Name	String	False
Description	String	False
RvDescription	String	False
ParentCategoryId	Integer	False
HeaderImage	String	False
BannerImage	String	False
MenuImage	String	False
MetaTitle	String	False
MetaKeywords	String	False
MetaDescription	String	False
Priority	Integer	False
Flag	Integer	False

Returns data from Customers table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.
• Custom field columns support the following operator: =.
• Password column does not support server side operators.

For example, the following query is processed server side:

    SELECT * FROM Customers WHERE CompName = 'Sample Company'
    SELECT * FROM Customers WHERE ParentId IN (1, 10)
    SELECT * FROM Customers WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

To add a Customers, specify TantoLastName, Zip, Pref, Address1, Address2, Password and the non-read-only columns.

    INSERT INTO Customers (TantoLastName, Zip, Pref, Address1, Address2, Password) VALUES ('Tanto', '123-4567', 'Miyagi', 'Sendai', 'CData', 'PASSWPRD')

Bulk Insert

    INSERT INTO Customers#TEMP (TantoLastName, Zip, Pref, Address1, Address2, Password) VALUES ('Tanto 1', '123-4567', 'Miyagi', 'Sendai', 'CData', 'PASSWPRD')
    INSERT INTO Customers#TEMP (TantoLastName, Zip, Pref, Address1, Address2, Password) VALUES ('Tanto 2', '123-4567', 'Miyagi', 'Sendai', 'CData', 'PASSWPRD')
    INSERT INTO Customers (Name, CategoryId) SELECT Name, CategoryId FROM Customers#TEMP

Update

Bcart allows updates for TantoLastName, Zip and the non-read-only columns.

    UPDATE Customers SET TantoLastName = 'Sample TantoLastName' WHERE Id = 2

Bulk Update

    INSERT INTO Customers#TEMP (Id, TantoLastName, Address1) VALUES (1, 'Sample TantoLastName 1', 'Sendai')
    INSERT INTO Customers#TEMP (Id, TantoLastName, Address1) VALUES (2, 'Sample TantoLastName 2', 'Sendai')
    UPDATE Customers (Id, TantoLastName, Address1) SELECT Id, TantoLastName, Address1 FROM Customers#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
ExtId	String	False
AgentId	String	False
AgentRate	String	False
ParentId	Integer	False
DestinationCode	String	False
CompName	String	False
CompNameKana	String	False
CeoLastName	String	False
CeoFirstName	String	False
CeoLastNameKana	String	False
CeoFirstNameKana	String	False
Department	String	False
TantoLastName	String	False
TantoFirstName	String	False
TantoLastNameKana	String	False
TantoFirstNameKana	String	False
Zip	String	False
Pref	String	False
Address1	String	False
Address2	String	False
Address3	String	False
Email	String	False
EmailCc	String	False
Tel	String	False
MobilePhone	String	False
Fax	String	False
Url	String	False
Foundation	String	False
Sales	Integer	False
Job	String	False
Memo	String	False
Payment	String	False
SpecialShippingCost	String	False
Paid	String	True
SpecialView	Integer	False
MmFlag	Integer	False
Point	Integer	False
PriceGroupId	Integer	False
ViewGroupId	Integer	False
SalesmanId	String	False
AfId	String	False
CutoffDate	String	False
PaymentMonth	String	False
PaymentDate	String	False
DefaultOtherShippingId	Integer	False
DefaultPayment	String	False
HiddenPrice	Integer	False
Status	String	False
Password	String	False
CreatedAt	Datetime	False
UpdatedAt	Datetime	False

Returns data from Logistics table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM Logistics WHERE Name = 'Sample Product'
    SELECT * FROM Logistics WHERE ShippingGroupId IN (1, 10)
    SELECT * FROM Logistics WHERE ShipmentDate <= '2019-09-26 09:20:45'

Insert

Insert is not supported for this table.

Update

Bcart allows updates for ShipmentCode, DeliveryCode and the non-read-only columns.

    UPDATE Logistics ShipmentCode = '123' WHERE Id = 20000001

Bulk Update

    INSERT INTO Logistics#TEMP (Id, ShipmentCode, Name) VALUES (20000001, 'Sample ShipmentCode 1', 'Sample Name 1')
    INSERT INTO Logistics#TEMP (Id, ShipmentCode, Name) VALUES (20000002, 'Sample ShipmentCode 2', 'Sample Name 2')
    UPDATE Logistics (Id, ShipmentCode, Name) SELECT Id, ShipmentCode, Name FROM Logistics#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
ShipmentCode	String	False
DeliveryCode	String	False
DestinationCode	String	False
ShippingGroupId	Integer	False
CompName	String	False
Department	String	False
Name	String	False
Zip	String	False
Pref	String	False
Address1	String	False
Address2	String	False
Address3	String	False
Tel	String	False
DueDate	Date	False
DueTime	String	False
Memo	String	False
ShipmentDate	Date	False
Status	String	False

Returns data from OrderProducts table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.
• Custom field columns support the following operator: =.
• Options column does not support server side operators.

For example, the following query is processed server side:

    SELECT * FROM OrderProducts WHERE ProductName = 'Sample Order Product'
    SELECT * FROM OrderProducts WHERE OrderId IN (1, 10)
    SELECT * FROM OrderProducts WHERE ShippingSize <= 10

Insert

Insert is not supported for this table.

Update

Bcart allows updates for ProductName, MainNo and the non-read-only columns.

    UPDATE OrderProducts SET ProductName = 'Sample Order Product' WHERE Id = 2

Bulk Update

    INSERT INTO OrderProducts#TEMP (Id, ProductName, MainNo) VALUES (1, 'Sample Order Product 1', '1')
    INSERT INTO OrderProducts#TEMP (Id, ProductName, MainNo) VALUES (2, 'Sample Order Product 2', '2')
    UPDATE OrderProducts (Id, ProductName, MainNo) SELECT Id, ProductName, MainNo FROM OrderProducts#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
OrderId	Integer	False
LogisticsId	Integer	False
ProductId	Integer	False
MainNo	String	False
ProductNo	String	False
JanCode	String	False
LocationNo	String	False
ProductName	String	False
ProductSetId	Integer	False
SetName	String	False
UnitPrice	Decimal	True
SetQuantity	Integer	True
SetUnit	String	False
OrderProCount	Integer	True
ShippingSize	Integer	False
TaxRate	String	True
TaxTypeId	Integer	True
TaxIncl	Integer	True
ItemType	String	True
Options	String	True

Returns data from Orders table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.
• Custom field columns support the following operator: =.

For example, the following query is processed server side:

    SELECT * FROM Orders WHERE CustomerCompName = 'Sample Customer'
    SELECT * FROM Orders WHERE Id IN (1, 10)
    SELECT * FROM Orders WHERE OrderedAt <= '2019-09-26 09:20:45'

Insert

Insert is not supported for this table.

Update

Bcart allows updates for CustomerCompName, Memo and the non-read-only columns.

    UPDATE Orders SET CustomerCompName = 'Sample Customer' WHERE Id = 2

Bulk Update

    INSERT INTO Orders#TEMP (Id, CustomerCompName, Memo) VALUES (1, 'Sample Customer 1', 'Sample Memo')
    INSERT INTO Orders#TEMP (Id, CustomerCompName, Memo) VALUES (2, 'Sample Customer 2', 'Sample Memo')
    UPDATE Orders (Id, CustomerCompName, Memo) SELECT Id, CustomerCompName, Memo FROM Orders#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
Code	String	True
CustomerId	Integer	False
CustomerExtId	String	False
CustomerParentId	Integer	False
CustomerSalesmanId	String	False
CustomerCompName	String	False
CustomerDepartment	String	False
CustomerName	String	False
CustomerTel	String	False
CustomerMobilePhone	String	False
CustomerEmail	String	False
CustomerPriceGroupId	String	False
CustomerZip	String	False
CustomerPref	String	False
CustomerAddress1	String	False
CustomerAddress2	String	False
CustomerAddress3	String	False
Payment	String	False
PaymentAt	Date	False
TotalPrice	Decimal	True
Tax	Decimal	True
TaxRate	String	True
CODCost	Decimal	True
ShippingCost	Decimal	True
FinalPrice	Decimal	True
UsePoint	Integer	True
GetPoint	Integer	True
OrderTotals	String	True
CustomerMessage	String	False
AdminMessage	String	False
Memo	String	False
Enquete1	String	False
Enquete2	String	False
Enquete3	String	False
Enquete4	String	False
Enquete5	String	False
OrderedAt	Datetime	True
AffiliateId	String	True
EstimateId	String	False
Status	String	False

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
QualifiedInvoice	Integer

Returns data from OrderStatuses table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM OrderStatuses WHERE Label = 'Sample Product'
    SELECT * FROM OrderStatuses WHERE Id IN (1, 10)
    SELECT * FROM OrderStatuses WHERE SystemDefined <= 5

Insert

To add a OrderStatuses, specify Label column.

    INSERT INTO OrderStatuses (Label) VALUES ('Sample Label')

Bulk Insert

    INSERT INTO OrderStatuses#TEMP (Label) VALUES ('Sample Label 1')
    INSERT INTO OrderStatuses#TEMP (Label) VALUES ('Sample Label 2')
    INSERT INTO OrderStatuses (Label) SELECT Label FROM OrderStatuses#TEMP

Update

Bcart allows updates for Label column.

    UPDATE OrderStatuses SET Label = 'Sample Label' WHERE Id = 2

Bulk Update

    INSERT INTO OrderStatuses#TEMP (Id, Label) VALUES (1, 'Sample Label 1')
    INSERT INTO OrderStatuses#TEMP (Id, Label) VALUES (2, 'Sample Label 2')
    UPDATE OrderStatuses (Id, Label) SELECT Id, Label FROM OrderStatuses#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True
Label	String	False
SystemDefined	Integer	True

Returns data from OtherAddresses table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM OtherAddresses WHERE Name = 'Sample Addresses'
    SELECT * FROM OtherAddresses WHERE Id IN (1, 10)
    SELECT * FROM OtherAddresses WHERE CustomerId <= 5

Insert

To add a OtherAddresses, specify Name, CustomerId and the non-read-only columns.

    INSERT INTO OtherAddresses (Name, Zip, Pref, Address1, Address2, CustomerId) VALUES ('Sample Address', '123-4567', 'Miyagi', 'Sendai', 'CData', 9999)

Bulk Insert

    INSERT INTO OtherAddresses#TEMP (Name, Zip, Pref, Address1, Address2, CustomerId) VALUES ('Sample Address 1', '123-4567', 'Miyagi', 'Sendai', 'CData', 9999)
    INSERT INTO OtherAddresses#TEMP (Name, Zip, Pref, Address1, Address2, CustomerId) VALUES ('Sample Address 2', '123-4567', 'Miyagi', 'Sendai', 'CData', 9999)
    INSERT INTO OtherAddresses (Name, Zip, Pref, Address1, Address2, CustomerId) SELECT Name, Zip, Pref, Address1, Address2, CustomerId FROM OtherAddresses#TEMP

Update

Bcart allows updates for Name, Zip and the non-read-only columns.

    UPDATE OtherAddresses SET Name = 'Sample Address' WHERE Id = 2

Bulk Update

    INSERT INTO OtherAddresses#TEMP (Id, Name) VALUES (1, 'Sample Address 1')
    INSERT INTO OtherAddresses#TEMP (Id, Name) VALUES (2, 'Sample Address 2')
    UPDATE OtherAddresses (Id, Name) SELECT Id, Name FROM OtherAddresses#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
CustomerId	Integer	False
DestinationCode	String	False
CompName	String	False
Department	String	False
Name	String	False
Zip	String	False
Pref	String	False
Address1	String	False
Address2	String	False
Address3	String	False
Tel	String	False

Returns data from Points table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM Points WHERE Status = 'Sample Status'
    SELECT * FROM Points WHERE Id IN (1, 10)
    SELECT * FROM Points WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

To add a Points, specify CustomerId, Point, Status and the non-read-only columns.

    INSERT INTO Points (CustomerId, Point, Status) VALUES (12345, 10, 'Sample Status')

Bulk Insert

    INSERT INTO Points#TEMP (CustomerId, Point, Status) VALUES (12345, 10, 'Sample Status')
    INSERT INTO Points#TEMP (CustomerId, Point, Status) VALUES (12346, 10, 'Sample Status')
    INSERT INTO Points (CustomerId, Point, Status) SELECT CustomerId, Point, Status FROM Points#TEMP

Update

Bcart allows updates for CustomerId, Point and the non-read-only columns.

    UPDATE Points SET Point = 10 WHERE Id = 2

Bulk Update

    INSERT INTO Points#TEMP (Id, Point) VALUES (1, 10)
    INSERT INTO Points#TEMP (Id, Point) VALUES (2, 20)
    UPDATE Points (Id, Point) SELECT Id, Point FROM Points#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
CustomerId	Integer	False
OrderId	Integer	False
SubjectId	Integer	False
Point	Integer	False
Status	String	False
ActivatedAt	Datetime	False
CreatedAt	Datetime	False
UpdatedAt	Datetime	False

Returns data from ProductFeatures table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM ProductFeatures WHERE Name = 'Sample ProductFeatures'
    SELECT * FROM ProductFeatures WHERE Id IN (1, 10)
    SELECT * FROM ProductFeatures WHERE Priority <= 5

Insert

To add a ProductFeatures, specify Name, Description and the non-read-only columns.

    INSERT INTO ProductFeatures (Name, Description) VALUES ('Sample Product Features', 'Description')

Bulk Insert

    INSERT INTO ProductFeatures#TEMP (Name, Description) VALUES ('Sample Product Features 1', 'Sample Description')
    INSERT INTO ProductFeatures#TEMP (Name, Description) VALUES ('Sample Product Features 2', 'Sample Description')
    INSERT INTO ProductFeatures (Name, Description) SELECT Name, Description FROM ProductFeatures#TEMP

Update

Bcart allows updates for Name, Description and the non-read-only columns.

    UPDATE ProductFeatures SET Name = 'Sample Product Features' WHERE Id = 2

Bulk Update

    INSERT INTO ProductFeatures#TEMP (Id, Name, Description) VALUES (1, 'Sample Product Features 1', 'Sample Description')
    INSERT INTO ProductFeatures#TEMP (Id, Name, Description) VALUES (2, 'Sample Product Features 2', 'Sample Description')
    UPDATE ProductFeatures (Id, Name, Description) SELECT Id, Name, Description FROM ProductFeatures#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
Name	String	False
RvDescription	String	False
Description	String	False
HeaderImage	String	False
BannerImage	String	False
MenuImage	String	False
MetaTitle	String	False
MetaKeywords	String	False
MetaDescription	String	False
Priority	Integer	False
Flag	Integer	False

Returns data from Products table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.
• Custom field columns support the following operator: =.
• SubImages1Image, SubImages1Caption and each SubImages number columns does not support server side operators.

For example, the following query is processed server side:

    SELECT * FROM Products WHERE Name = 'Sample Product'
    SELECT * FROM Products WHERE Id IN (1, 10)
    SELECT * FROM Products WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

To add a Products, specify Name, CategoryId and the non-read-only columns.

    INSERT INTO Products (Name, CategoryId) VALUES ('Sample Product', 2)

Bulk Insert

    INSERT INTO Products#TEMP (Name, CategoryId) VALUES ('Sample Product 1', 2)
    INSERT INTO Products#TEMP (Name, CategoryId) VALUES ('Sample Product 2', 2)
    INSERT INTO Products (Name, CategoryId) SELECT Name, CategoryId FROM Products#TEMP

Update

Bcart allows updates for Name, CategoryId and the non-read-only columns.

    UPDATE Products SET Name = 'Sample Product' WHERE Id = 2

Bulk Update

    INSERT INTO Products#TEMP (Id, Name, CategoryId) VALUES (1, 'Sample Product 1', 2)
    INSERT INTO Products#TEMP (Id, Name, CategoryId) VALUES (2, 'Sample Product 2', 2)
    UPDATE Products (Id, Name, CategoryId) SELECT Id, Name, CategoryId FROM Products#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
MainNo	String	False
Name	String	False
CatchCopy	String	False
CategoryId	Integer	False
SubCategoryId	String	False
FeatureId1	Integer	False
FeatureId2	Integer	False
FeatureId3	Integer	False
MadeIn	String	False
Size	String	False
Sozai	String	False
Caution	String	False
Tag	String	False
Description	String	False
MetaTitle	String	False
MetaKeywords	String	False
MetaDescription	String	False
Image	String	False
ViewGroupFilter	String	False
VisibleCustomerId	String	False
PrependText	String	False
AppendText	String	False
MiddleText	String	False
RvPrependText	String	False
RvAppendText	String	False
RvMiddleText	String	False
FileDownload	String	False
HanbaiStart	Datetime	False
HanbaiEnd	Datetime	False
RecommendProductId	String	False
ViewPattern	Integer	False
Priority	Integer	False
Flag	String	False
UpdatedAt	Datetime	False
SubImages1Image	String	False
SubImages1Caption	String	False
SubImages2Image	String	False
SubImages2Caption	String	False
SubImages3Image	String	False
SubImages3Caption	String	False
SubImages4Image	String	False
SubImages4Caption	String	False
SubImages5Image	String	False
SubImages5Caption	String	False
SubImages6Image	String	False
SubImages6Caption	String	False

Returns data from ProductSets table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.
• Custom field columns support the following operator: =.
• GroupPrice1Name, GroupPrice1Rate and each GroupPrice number columns does not support server side operators.

For example, the following query is processed server side:

    SELECT * FROM ProductSets WHERE Name = 'Sample ProductSets'
    SELECT * FROM ProductSets WHERE Id IN (1, 10)
    SELECT * FROM ProductSets WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

To add a ProductSets, specify Name, ProductId, UnitPrice and the non-read-only columns.

    INSERT INTO ProductSets (Name, ProductId, UnitPrice) VALUES ('Sample Product Set', 2, 1000)

Bulk Insert

    INSERT INTO ProductSets#TEMP (Name, ProductId, UnitPrice) VALUES ('Sample Product Set 1', 2, 1000)
    INSERT INTO ProductSets#TEMP (Name, ProductId, UnitPrice) VALUES ('Sample Product Set 2', 2, 1000)
    INSERT INTO ProductSets (Name, ProductId, UnitPrice) SELECT Name, ProductId, UnitPrice FROM ProductSets#TEMP

Update

Bcart allows updates for Name, ProductId, UnitPrice and the non-read-only columns.

    UPDATE ProductSets SET Name = 'Sample Product Set' WHERE Id = 2

Bulk Update

    INSERT INTO ProductSets#TEMP (Id, Name, UnitPrice) VALUES (1, 'Sample Product Set 1', 2000)
    INSERT INTO ProductSets#TEMP (Id, Name, UnitPrice) VALUES (2, 'Sample Product Set 2', 3000)
    UPDATE ProductSets (Id, Name, UnitPrice) SELECT Id, Name, UnitPrice FROM ProductSets#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True
ProductId	Integer	False
ProductNo	String	False
JanCode	String	False
LocationNo	String	False
JodaiType	String	False
Jodai	Integer	False
Name	String	False
UnitPrice	Decimal	False
MinOrder	Integer	False
MaxOrder	Integer	False
GroupPrice1Name	String	False
GroupPrice1Rate	String	False
GroupPrice1UnitPrice	Decimal	False
GroupPrice1FixedPrice	Decimal	False
GroupPrice1VolumeDiscount	String	False
GroupPrice2Name	String	False
GroupPrice2Rate	String	False
GroupPrice2UnitPrice	Decimal	False
GroupPrice2FixedPrice	Decimal	False
GroupPrice2VolumeDiscount	String	False
GroupPrice3Name	String	False
GroupPrice3Rate	String	False
GroupPrice3UnitPrice	Decimal	False
GroupPrice3FixedPrice	Decimal	False
GroupPrice3VolumeDiscount	String	False
GroupPrice4Name	String	False
GroupPrice4Rate	String	False
GroupPrice4UnitPrice	Decimal	False
GroupPrice4FixedPrice	Decimal	False
GroupPrice4VolumeDiscount	String	False
GroupPrice5Name	String	False
GroupPrice5Rate	String	False
GroupPrice5UnitPrice	Decimal	False
GroupPrice5FixedPrice	Decimal	False
GroupPrice5VolumeDiscount	String	False
GroupPrice6Name	String	False
GroupPrice6Rate	String	False
GroupPrice6UnitPrice	Decimal	False
GroupPrice6FixedPrice	Decimal	False
GroupPrice6VolumeDiscount	String	False
GroupPrice7Name	String	False
GroupPrice7Rate	String	False
GroupPrice7UnitPrice	Decimal	False
GroupPrice7FixedPrice	Decimal	False
GroupPrice7VolumeDiscount	String	False
GroupPrice8Name	String	False
GroupPrice8Rate	String	False
GroupPrice8UnitPrice	Decimal	False
GroupPrice8FixedPrice	Decimal	False
GroupPrice8VolumeDiscount	String	False
GroupPrice9Name	String	False
GroupPrice9Rate	String	False
GroupPrice9UnitPrice	Decimal	False
GroupPrice9FixedPrice	Decimal	False
GroupPrice9VolumeDiscount	String	False
GroupPrice10Name	String	False
GroupPrice10Rate	String	False
GroupPrice10UnitPrice	Decimal	False
GroupPrice10FixedPrice	Decimal	False
GroupPrice10VolumeDiscount	String	False
GroupPriceNName	String	False
GroupPriceNRate	String	False
GroupPriceNUnitPrice	Decimal	False
GroupPriceNFixedPrice	Decimal	False
GroupPriceNVolumeDiscount	String	False
SpecialPrice	String	False
VolumeDiscount	String	False
Quantity	Integer	False
Unit	String	False
Description	String	False
Stock	Integer	False
StockFlag	Integer	False
StockParent	String	False
StockViewId	Integer	False
StockFew	Integer	False
ViewGroupFilter	String	False
VisibleCustomerId	String	False
OptionIds	String	False
ShippingGroupId	Integer	False
ShippingSize	Integer	False
Priority	Integer	False
SetFlag	String	False
TaxTypeId	Integer	False
UpdatedAt	Datetime	False

Returns data from ProductStock table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM ProductStock WHERE Name = 'Sample Stock'
    SELECT * FROM ProductStock WHERE Id IN (1, 10)
    SELECT * FROM ProductStock WHERE Stock <= 10

Insert

Insert is not supported for this table.

Update

Bcart allows updates for Stock, StockFlag and the non-read-only columns.

    UPDATE ProductStock SET Stock = 15 WHERE ProductNo = 2

If need update the number of stocks by relative value, Specify relative value by StockRelativeUpdateValue.

The following query reduces the number of stocks by two.

    UPDATE ProductStock SET StockRelativeUpdateValue = -1 WHERE ProductNo = 2

Bulk Update

    INSERT INTO ProductStock#TEMP (ProductNo, Stock) VALUES ('A001', 2)
    INSERT INTO ProductStock#TEMP (ProductNo, Stock) VALUES ('A002', 3)
    UPDATE ProductStock (ProductNo, Stock) SELECT ProductNo, Stock FROM ProductStock#TEMP

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id	Integer	True
ProductId	Integer	True
ProductNo [KEY]	String	True
Name	String	True
Stock	Integer	False
StockFlag	Integer	False
StockParent	String	False

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
StockRelativeUpdateValue	String

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

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

CData Cloud - Bcart Views

Name	Description
PriceGroups	Usage information for the operation PriceGroups.rsd.
ProductOptions	Usage information for the operation ProductOptions.rsd.
ShippingGroups	Usage information for the operation ShippingGroups.rsd.
ViewGroups	Usage information for the operation ViewGroups.rsd.

Returns data from PriceGroups table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM PriceGroups WHERE Name = 'Sample PriceGroups'
    SELECT * FROM PriceGroups WHERE Id IN (1, 10)
    SELECT * FROM PriceGroups WHERE Id <= '10'

Columns

Name	Type	Description
Id [KEY]	String
Name	String
Rate	String

Returns data from ProductOptions table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.
• Custom field columns support the following operator: =.
• InputRulesType, InputRulesLimitType, InputRulesLimitMin and InputRulesLimitMax columns does not support server side operators.

For example, the following query is processed server side:

    SELECT * FROM ProductOptions WHERE Name = 'Sample ProductOptions'
    SELECT * FROM ProductOptions WHERE Id IN (1, 10)
    SELECT * FROM ProductOptions WHERE UpdatedAt <= '2019-09-26 09:20:45'

Columns

Name	Type	Description
Id [KEY]	Integer
Name	String
IsActive	Integer
InputType	String
InputChoices	String
InputRulesType	String
InputRulesLimitType	String
InputRulesLimitMin	String
InputRulesLimitMax	String
Unit	String
IsDescriptionHtml	Integer
Description	String
Required	Boolean
SortPriority	Integer
CreatedAt	Datetime
UpdatedAt	Datetime

Returns data from ShippingGroups table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.
• CodCost, DueHour and Cost columns does not support server side operators.

For example, the following query is processed server side:

    SELECT * FROM ShippingGroups WHERE Name = 'Sample ShippingGroups'
    SELECT * FROM ShippingGroups WHERE Id IN (1, 10)
    SELECT * FROM ShippingGroups WHERE CostFreePrice <= 10

Columns

Name	Type	Description
Id [KEY]	Integer
Name	String
Description	String
Company	Integer
ShippingOtherFlag	String
CodCost	String
CodCostMaxPrice	String
CodCostMaxCost	String
CodFlag	Integer
TaxIncluded	Integer
TaxRounding	String
TaxCodIncluded	Integer
TaxCodRounding	String
DueDateFlag	Integer
DueDateStartDay	String
DueDateIncrement	String
DueDateCarryoverHourFlag	Integer
DueDateCarryoverHour	String
DueDateCarryoverHolidayFlag	Integer
DueDateDescription	String
DueHourFlag	Integer
DueHour	String
DueHourDescription	String
OtherFlag	Integer
CodeUrl	String
CostFreeFlag	Integer
CostFreePrice	Decimal
Cost	String
CostText	String

Returns data from ViewGroups table.

Select

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

• Most of the columns support the following operators: <, >, <=, >=, =, !=, IN, NOT_IN.

For example, the following query is processed server side:

    SELECT * FROM ViewGroups WHERE Name = 'Sample ViewGroups'
    SELECT * FROM ViewGroups WHERE Id IN (1, 10)
    SELECT * FROM ViewGroups WHERE Id <= 10

Columns

Name	Type	Description
Id [KEY]	Integer
Name	String

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

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

CData Cloud - Bcart Stored Procedures

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

Schema Tables

The following tables return database metadata for Bcart:

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

Data Source Tables

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

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

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

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

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

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

Describes the columns of the available tables and views.

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

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

Columns

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

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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

Describes stored procedure parameters.

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

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

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

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

Columns

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

Pseudo-Columns

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

Describes the primary and foreign keys.

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

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

Columns

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

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

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

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys
          

Columns

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

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Columns

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

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity
          

Columns

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

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

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

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

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

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Bcart.
PersonalAccessToken	The Personal Access Token allows you to make requests to the Bcart API.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

SSL

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

Property	Description
IncludeCustomFields	Set this to true if you want to retrieve custom fields from each table.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseDisplayNames	If set to true, Display name of custom field will be used for each column name.

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

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Bcart.
PersonalAccessToken	The Personal Access Token allows you to make requests to the Bcart API.

The type of authentication to use when connecting to Bcart.

Possible Values

OAuth, PersonalAccessToken

Data Type

string

Default Value

"PersonalAccessToken"

Remarks

• OAuth: Set to this to perform OAuth authentication with the code grant type.
• PersonalAccessToken: Set to this to perform Personal Access Token authentication.

The Personal Access Token allows you to make requests to the Bcart API.

Data Type

string

Default Value

""

Remarks

After logging in to Bcart API Management page, go to the Application Management, click Create New Token, enter the Name and slelect the necessary permissions. After that you can get the Personal Access Token.

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

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Data Type

string

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

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

---

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

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

Data Type

string

Default Value

""

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.

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

---

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

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

Data Type

string

Default Value

"1"

Remarks

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

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

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

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

---

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

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

Data Type

string

Default Value

""

Remarks

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

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

---

Property	Description
IncludeCustomFields	Set this to true if you want to retrieve custom fields from each table.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseDisplayNames	If set to true, Display name of custom field will be used for each column name.

Set this to true if you want to retrieve custom fields from each table.

Possible Values

TRUE, FALSE

Data Type

bool

Default Value

false

Remarks

Set this to true if you want to retrieve custom fields from each table.

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

Data Type

int

Default Value

-1

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.

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

Data Type

string

Default Value

""

Remarks

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

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

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

Data Type

int

Default Value

60

Remarks

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

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

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

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

If set to true, Display name of custom field will be used for each column name.

Possible Values

TRUE, FALSE

Data Type

bool

Default Value

false

Remarks

If set to true, Display name of custom field will be used for each column name.

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.