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

Connecting to Business b-ridge

Establishing a Connection shows how to authenticate to Business b-ridge and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Business b-ridge through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Business b-ridge 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.

Before You Connect

Subscription Key

To obtain the SubscriptionKey, follow the steps below:

• Log in to Business b-ridge API Protal and go to Profile in the Your name menu.
• In your subscription section, click Main Key to retrieve the key. You will later set this key value in the SubscriptionKey connection property.

Connecting to Business b-ridge

Set the following connection properties to connect:

• CompanyKey: Set this to the Business b-ridge Company Key.
• ProjectKey: Set this to the Business b-ridge Project Key.
• SubscriptionKey: Set this to the noted subscription key.

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 Business b-ridge APIs.

Key Features

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

Views

Views describes the available views. Views are statically defined to model ContentVersions and Users.

Tables

The Cloud exposes Tables from Business b-ridge. For every table, Cloud will autogenerate a child table named TableName_Contents for exposing information of contents of that table. For example if table name is CDATA, autogenerated child table name would be CDATA_Contents. Almost very table supports INSERT, UPDATE, DELETE, BULKINSERT, BULKUPDATE AND BULKDELETE operations.

Stored Procedures

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

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

CData Cloud - Business b-ridge Tables

Name	Description
CDATA	Query information regarding CDATA table.
CDATA_Contents	Query information regarding CDATA_Contents table.

Query information regarding CDATA table.

Select

The Cloud will use the Business b-ridge API to process WHERE clause conditions and selected columns. Operators: =, !=,

, >, <, >=, <=, AND, OR, CONTAINS are processed server-side. For example, the following queries are processed server side:

SELECT * FROM CDATA WHERE CreateDate < '2020-02-14 00:13:57.5'

SELECT * FROM CDATA WHERE (CONTAINS (SampleColumn002, 'b-ri') AND SampleColumn001 = 'ADO') OR SampleColumn001 = 'JDBC'")

SELECT * FROM CDATA WHERE (SampleColumn002 > 2 OR SampleColumn002 = 5) AND (SampleColumn001 = 'M2' OR SampleColumn001 != 'M5') OR ItemId = '0205a94cd35f2a25025b5be9d7c4fc15'

In order to query parent-child relationship specify ParentTableName and ParentItemId.

SELECT * FROM Drivers WHERE ParentTableName = 'CDATA' AND ParentItemId = '3b47216073e89641b718ef07cb1f80a8'

Insert

Columns other than ItemId are required for a successful insert.

INSERT INTO CDATA (SampleColumn002, SampleColumn003, StructureId) VALUES ('Businessbridge', 'JDBC', '2ef8217323d0d25632dbcd2a8dbca')

For inserting a record as a child to another record, you have to specify ParentTableName and ParentItemId colums.

INSERT INTO Drivers (SampleColumn002, SampleColumn003, ParentTableName, ParentItemId) VALUES ('Businessbridge', 'Excel', 'CDATA', 3b47216073e89641b718ef07cb1f80a8)

Update

All columns with readOnly= false can be updated.

UPDATE CDATA SET SampleColumn002 = 'Businessbridge' WHERE ItemId = '0d6fd6470c1cf8e8bc96bc74b528d502'

Delete

Records can be deleted by providing the ItemId.

DELETE FROM CDATA WHERE ItemId = '93147a976bbe4dfa9f1949e78883395c'

Bulk Insert

INSERT INTO CDATA#TEMP (SampleColumn002, SampleColumn003, StructureId) VALUES ('Businessbridge', 'JDBC', '2ef82173227e3d0d25632dbcd2a8dbca')
INSERT INTO CDATA#TEMP (SampleColumn002, SampleColumn003, StructureId) VALUES ('Businessbridge', 'ADO', '2ef82173227e3d0d25632dbcd2a8dbca')
INSERT INTO CDATA (SampleColumn002, SampleColumn003, StructureId) SELECT SampleColumn002, SampleColumn003, StructureId FROM CDATA#TEMP

Bulk Update

INSERT INTO CDATA#TEMP (ItemId, SampleColumn002, SampleColumn003) VALUES ('36d1ad5f385d44259f264cfffdc9f9c9', 'Businessbridge', 'JDBC')
INSERT INTO CDATA#TEMP (ItemId, SampleColumn002, SampleColumn003) VALUES ('36d1ad5f385d44259f264cfffdc9f9c9', 'Businessbridge', 'ADO')
UPDATE CDATA (ItemId, SampleColumn002, SampleColumn003) SELECT ItemId, SampleColumn002, SampleColumn003 FROM CDATA#TEMP

Bulk Delete

INSERT INTO CDATA#TEMP (ItemId) VALUES (ff5e9e7782e74a189aeac478e64cd5a0)
INSERT INTO CDATA#TEMP (ItemId) VALUES (fed05ded8d504f0cb8da441c9dfdbc96)
INSERT INTO CDATA#TEMP (ItemId) VALUES (343434343434r234r3reedfsdfw23ere)
DELETE FROM CDATA WHERE EXISTS SELECT ItemId FROM CDATA#TEMP

Columns

Name	Type	ReadOnly	Description
ItemId [KEY]	String	False
SampleColumn001	String	False
SampleColumn002	String	False
SampleColumn003	String	False
SampleColumn004	String	False
SampleColumn005	String	False
SampleColumn006	String	False
SampleColumn007	String	False
SampleColumn008	String	False
SampleColumn009	String	False
SampleColumn010	String	False
SampleColumn011	String	False
SampleColumn012	String	False
SampleColumn013	String	False
SampleColumn014	String	False
SampleColumn015	String	False
SampleColumn016	String	False
SampleColumn017	String	False
SampleColumn018	String	False
SampleColumn019	String	False
SampleColumn020	String	False
SampleColumn021	String	False
SampleColumn022	String	False
SampleColumn023	String	False
SampleColumn024	String	False
SampleColumn025	String	False
SampleColumn026	String	False
SampleColumn027	String	False
SampleColumn028	String	False
SampleColumn029	String	False
SampleColumn030	String	False
SampleColumn031	String	False
SampleColumn032	String	False
SampleColumn033	String	False
SampleColumn034	String	False
SampleColumn035	String	False
SampleColumn036	String	False
SampleColumn037	String	False
SampleColumn038	String	False
SampleColumn039	String	False
SampleColumn040	String	False
SampleColumn041	String	False
SampleColumn042	String	False
SampleColumn043	String	False
SampleColumn044	String	False
SampleColumn045	String	False
SampleColumn046	String	False
SampleColumn047	String	False
SampleColumn048	String	False
SampleColumn049	String	False
SampleColumn050	String	False
SampleColumn051	String	False
SampleColumn052	String	False
SampleColumn053	String	False
SampleColumn054	String	False
SampleColumn055	String	False
SampleColumn056	String	False
SampleColumn057	String	False
SampleColumn058	String	False
SampleColumn059	String	False
SampleColumn060	String	False
SampleColumn061	String	False
SampleColumn062	String	False
SampleColumn063	String	False
SampleColumn064	String	False
SampleColumn065	String	False
SampleColumn066	String	False
SampleColumn067	String	False
SampleColumn068	String	False
SampleColumn069	String	False
SampleColumn070	String	False
SampleColumn071	String	False
SampleColumn072	String	False
SampleColumn073	String	False
SampleColumn074	String	False
SampleColumn075	String	False
SampleColumn076	String	False
SampleColumn077	String	False
SampleColumn078	String	False
SampleColumn079	String	False
SampleColumn080	String	False
SampleColumn081	String	False
SampleColumn082	String	False
SampleColumn083	String	False
SampleColumn084	String	False
SampleColumn085	String	False
SampleColumn086	String	False
SampleColumn087	String	False
SampleColumn088	String	False
SampleColumn089	String	False
SampleColumn090	String	False
SampleColumn091	String	False
SampleColumn092	String	False
SampleColumn093	String	False
SampleColumn094	String	False
SampleColumn095	String	False
SampleColumn096	String	False
SampleColumn097	String	False
SampleColumn098	String	False
SampleColumn099	String	False
SampleColumn100	String	False
SampleColumn101	String	False
SampleColumn102	String	False
SampleColumn103	String	False
SampleColumn104	String	False
SampleColumn105	String	False
SampleColumn106	String	False
SampleColumn107	String	False
SampleColumn108	String	False
SampleColumn109	String	False
SampleColumn110	String	False
SampleColumn111	String	False
SampleColumn112	String	False
SampleColumn113	String	False
SampleColumn114	String	False
SampleColumn115	String	False
SampleColumn116	String	False
SampleColumn117	String	False
SampleColumn118	String	False
SampleColumn119	String	False
SampleColumn120	String	False
SampleColumn121	String	False
SampleColumn122	String	False
SampleColumn123	String	False
SampleColumn124	String	False
SampleColumn125	String	False
SampleColumn126	String	False
SampleColumn127	String	False
SampleColumn128	String	False
SampleColumn129	String	False
SampleColumn130	String	False
SampleColumn131	String	False
SampleColumn132	String	False
SampleColumn133	String	False
SampleColumn134	String	False
SampleColumn135	String	False
SampleColumn136	String	False
SampleColumn137	String	False
SampleColumn138	String	False
SampleColumn139	String	False
SampleColumn140	String	False
SampleColumn141	String	False
SampleColumn142	String	False
SampleColumn143	String	False
SampleColumn144	String	False
SampleColumn145	String	False
SampleColumn146	String	False
SampleColumn147	String	False
SampleColumn148	String	False
SampleColumn149	String	False
SampleColumn150	String	False
ArchiveFlg	Integer	False
CategoryCode	String	False
CategoryId	String	False
CreateDate	Datetime	False
CreatedBy	String	False
CreatedByUserName	String	False
ItemTypeId	String	False
LinkUrl	String	False
OutputSetId	String	False
ParamId	String	False
ParentParamId	String	False
ParentParamName	String	False
StatusId	String	False
StructureId	String	False
UpdateDate	Datetime	False
UpdatedBy	String	False
UpdatedByUserName	String	False

Query information regarding CDATA_Contents table.

Select

CdataItemId column is required for this table. The following query is processed server side:

SELECT * FROM CDATA_Contents WHERE CdataItemId = '994497c2d6674c0d82e293537478be11'

Insert

For child tables ParentItemId, Title and BlobAddress columns are required. For example CDataItemId is required in CData_Contents. BlobAddress is the id of the uploaded file in blob storage. In order to get this id, you have to execute UploadFile stored procedure.

INSERT INTO CDATA_Contents (CdataItemId, Title, BlobAddress) VALUES ('994497c2d6674c0d82e293537478be11', 'API content', 'ue6b9f7a2b5374044aada6540811e1e76z_20200306090817.csv')

Update

All columns with readOnly= false can be updated.

UPDATE CDATA_Contents SET Title = 'Updated3' WHERE ID = '000002' AND CdataItemId = '45265dbdbbcd44aaa56ccced249b0a97'

Bulk Insert

INSERT INTO CDATA_Contents#TEMP (CdataItemId, Title, BlobAddress) VALUES ('994497c2d6674c0d82e293537478be11', 'API content', '637196255419198672_codecode.jpg')
INSERT INTO CDATA_Contents#TEMP (CdataItemId, Title, BlobAddress) VALUES ('994497c2d6674c0d82e293537478be11', 'API content', '637196255835825455_codecode.jpg')
INSERT INTO CDATA_Contents (CdataItemId, Title, BlobAddress) SELECT CdataItemId, Title, BlobAddress from CDATA_Contents#TEMP

Bulk Update

INSERT INTO CDATA_Contents#TEMP (ItemId, Title) VALUES ('86d0872f574243ffb5118c34ef13b4a5', 'API content33')
INSERT INTO CDATA_Contents#TEMP (ItemId, Title) VALUES ('f6d39662ca83b4b4f9dc0d73ab884916', 'API content33')
UPDATE CDATA_Contents (ItemId, Title) SELECT ItemId, Title from CDATA_Contents#TEMP

Columns

Name	Type	ReadOnly	Description
CDATAItemId	String	False	Id of the CDATA item that you want to query contents.
ID	String	False
Title	String	False
Version	String	False
Contents Name	String	False
Size	String	False
Comment	String	False
UpdatedByUserName	String	True
UpdateDate	Datetime	True
Edit Status	String	False
Edit User Name	String	False
Location	String	False
CreatedByUserName	String	True
CreateDate	Datetime	True
BlobAddress	String	False
Edit User ID	String	False
VersionId	String	False
Sign Date	Datetime	False
Signer Name	String	False
Signer Email Address	String	False
Sign Reason	String	False
Sign Title	String	False
Validation Status	String	False
Certificate Status	String	False
Sign Version ID	String	False
ReportId	String	False
Check In/Out	String	False
Report Parent ItemId	String	False
Mode	String	False
Width	Int	False
Height	Int	False
Cache Status	String	False
Text	String	False
Color	String	False
Position	String	False
Width(%)	Int	False
Viewing	String	False
Printing	String	False
CreatedBy	String	True
UpdatedBy	String	True
ItemId [KEY]	String	True
StructureId	String	False
ItemTypeId	String	False
ParentParamId	String	True
ParentParamName	String	True
ArchiveFlg	Int	True
ColumnVersion	String	True
MsgHistory	String	True
ReferenceItems	String	True

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 - Business b-ridge Views

Name	Description
ContentVersions	Query information regarding content versions.
Users	Query information regarding users.

Query information regarding content versions.

Select

ItemId column is required for this table. The following query is processed server side:

SELECT * FROM ContentVersions WHERE ItemId = 'f6d39662ca83b4b4f9dc0d73ab884916'

Columns

Name	Type	Description
ItemId	String	Id of the item.
BlobId	String	Id of the blob.
ContentType	String	Type of the content.
FileTitle	String	Title of the file.
FileName	String	Name of the file.
FileSize	String	Size of the file.
FileVersion	String	Version of the file.
FileComment	String	Comment of the file.
Latest	Boolean	Shows if version of the file is the latest.
UpdateDate	Datetime	Date of update.
UpdatedBy	String	Id of the user who updated content.
UpdatedByUserName	String	Name of the user who updated content.

Query information regarding users.

Columns

Name	Type	Description
Id [KEY]	String	If of the user.
Name	String	Name of the user.
AdminFlag	Int	Specifies if current user is administrator.
CircleAttr1	String	Circle attribute of the user.
CircleAttr2	String	Circle attribute of the user.
CircleAttr3	String	Circle attribute of the user.
CircleAttr4	String	Circle attribute of the user.
CircleAttr5	String	Circle attribute of the user.
Language	String	Language of the user.
MailAddress	String	Mail address of the user.
MailType	String	Mail type of the user.
Attribute1	String	Attribute of the user.
Attribute2	String	Attribute of the user.
Attribute3	String	Attribute of the user.
Attribute4	String	Attribute of the user.
Attribute5	String	Attribute of the user.
SubMailAddress1	String	First sub mail address of the user.
SubMailType1	String	First sub mail type of the user.
SubMailAddress2	String	Second sub mail address of the user.
SubMailType2	String	Second sub mail type of the user.
SubMailAddress3	String	Third sub mail address of the user.
SubMailType3	String	Third sub mail type of the user.

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

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

CData Cloud - Business b-ridge Stored Procedures

Name	Description
AssignParentChildRelationships	You can create parent-child relationships between data records or contents record to data record.
ExportCSV	Export csv for and return csv's blobId.
GetIncrementedNumber	You can increment a sequential number and get the incremented one. The sequential number's key is unique in an app. If the incremented one is over the limit,it will be rounded up to the initial sequential number.
OutputDataRecord	Add a new Output data record related to OutputSetId.
SendEmailsToAppAdmin	Send Emails to the specified AppAdmin.
SendNoticeToUser	You can specify more than one UserID for 'recipients'. If more than one user is specified as 'recipients', a notice is sent to each user.
SetupOrResetSequentialNumber	You can setup or reset a sequential number. The sequential number's key is unique in an app.
UnAssignParentChildRelationships	You can remove parent-child relationships between data records or contents record to datarecord.
UpdateContentsFileVersion	Update a contents file version.

You can create parent-child relationships between data records or contents record to data record.

Input

Name	Type	Required	Description
ParamCode	String	True	A code that identifies a form uniquely.
FromItemId	String	True	An ItemID that identifies a data record of assign/unassign source.
ToParamCode	String	True	A code that uniquely identifies a form of assign destination.
ToItemIds	String	True	A list of ItemIDs that identify data records of assign destination separated with ','.

Result Set Columns

Name	Type	Description
Success	String	Returns True if the parent-child assignment succeed.

Export csv for and return csv's blobId.

Input

Name	Type	Required	Description
ParamCode	String	True	A code that identifies a form uniquely.

Result Set Columns

Name	Type	Description
Success	String	Returns True if export succeed.
BlobId	String	The blobId of the exported CSV file

You can increment a sequential number and get the incremented one. The sequential number's key is unique in an app. If the incremented one is over the limit,it will be rounded up to the initial sequential number.

Input

Name	Type	Required	Description
Key	String	True	Sequential number key.

Result Set Columns

Name	Type	Description
Success	String	Returns True if the increment succeed.
Seq_Number	String	Sequence number

Add a new Output data record related to OutputSetId.

Input

Name	Type	Required	Description
ParamCode	String	True	A code that identifies a form uniquely.
ItemId	String	True	Id of the item.
OutputSetCode	String	True	Output set id.

Result Set Columns

Name	Type	Description
Success	String	Returns True if it succeed.

Send Emails to the specified AppAdmin.

Input

Name	Type	Required	Description
Subject	String	True	Subject of the email.
Body	String	True	Body of the email.

Result Set Columns

Name	Type	Description
Success	String	Returns True if email is sent.

You can specify more than one UserID for 'recipients'. If more than one user is specified as 'recipients', a notice is sent to each user.

Input

Name	Type	Required	Description
Sender	String	True	Sender of the notice.
Recipients	String	True	Recipients of the notice separated with ','.
Subject	String	True	Subject of the notice.
Body	String	True	Body of the notice.
Caption	String	False	Caption of the notice.
Label	String	False	Label of the notice.
EnableHomeMessage	String	False	Enable home message of the notice.
ParamCode	String	False	A code that identifies a form uniquely.
ItemId	String	False	Id of the item.

Result Set Columns

Name	Type	Description
Success	String	Returns True if notice is sent.

You can setup or reset a sequential number. The sequential number's key is unique in an app.

Input

Name	Type	Required	Description
Key	String	True	Sequential number key.
InitialSeqNumber	String	True	Initial sequential number.
LimitSeqNumber	String	True	Limit sequential number.
Increment	String	True	Increment of the key.

Result Set Columns

Name	Type	Description
Success	String	Returns True if setup or reset succeed.

You can remove parent-child relationships between data records or contents record to datarecord.

Input

Name	Type	Required	Description
ParamCode	String	True	A code that identifies a form uniquely.
FromItemId	String	True	An ItemID that identifies a data record of assign/unassign source.
TargetParamCode	String	True	A code that uniquely identifies a form of unassign destination.
TargetItemIds	String	True	A list of ItemIDs that identify data records of unassign destination separated with ','.

Result Set Columns

Name	Type	Description
Success	String	Returns True if parent-child unassignment succeed.

Update a contents file version.

Input

Name	Type	Required	Description
ContentsItemId	String	True	An ID that identifies a contents record uniquely.
FileTitle	String	False	Title of the file.
FileVersion	String	True	Version of the file.
FileComment	String	False	Comment of the file.
BlobId	String	True	Id of the blob.

Result Set Columns

Name	Type	Description
Success	String	Returns True if update succeed.

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 Business b-ridge:

• 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 CDATA table:

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

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 GetIncrementNumber stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetIncrementNumber' 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 = 'GetIncrementNumber' 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 Business b-ridge 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 CDATA table:

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

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 Cloud maps types from the data source to the corresponding data type available in the schema. The following table documents these mappings.

Data Type Mapping

Business b-ridge UI JP	Business b-ridge API Type	CData Schema
Character	string	string
Characters (with line break)	string	string
Integer	int	integer
Integer (with comma)	int3	integer
Minority	decimal	decimal
Minority (with comma)	decimal3	decimal
date	date	date
CreateDate	datetime	timestamp
UpdateDate	datetime	timestamp

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
CompanyKey	Together with ProjectKey and SubscriptionKey , this field is used to provide authentication for the user to B-ridge's servers.
SubscriptionKey	Together with ProjectKey and CompanyKey , this field is used to provide authentication for the user to B-ridge's servers.
ProjectKey	Together with CompanyKey and SubscriptionKey , this field is used to provide authentication for the user to B-ridge's servers.
URL	The URL of the B-ridge account.

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
AllowNonKeyColumnInWhereClause	Set the connection property AllowNonKeyColumnInWhereClause as true to execute an update batch without specifying the key columns.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Business b-ridge.
PollingInterval	This determines the polling interval in milliseconds to check whether the result is ready to be retrieved.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
QueryTimeout	The timeout in seconds for requests issued by the provider to process large result sets.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSandbox	Set to true if you want to use user test environment.

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

---

Property	Description
CompanyKey	Together with ProjectKey and SubscriptionKey , this field is used to provide authentication for the user to B-ridge's servers.
SubscriptionKey	Together with ProjectKey and CompanyKey , this field is used to provide authentication for the user to B-ridge's servers.
ProjectKey	Together with CompanyKey and SubscriptionKey , this field is used to provide authentication for the user to B-ridge's servers.
URL	The URL of the B-ridge account.

Together with ProjectKey and SubscriptionKey , this field is used to provide authentication for the user to B-ridge's servers.

Data Type

string

Default Value

""

Remarks

Together with ProjectKey and SubscriptionKey, this field is used to provide authentication for the user to B-ridge's servers.

Together with ProjectKey and CompanyKey , this field is used to provide authentication for the user to B-ridge's servers.

Data Type

string

Default Value

""

Remarks

Together with ProjectKey and CompanyKey, this field is used to provide authentication for the user to B-ridge's servers.

Together with CompanyKey and SubscriptionKey , this field is used to provide authentication for the user to B-ridge's servers.

Data Type

string

Default Value

""

Remarks

Together with CompanyKey and SubscriptionKey, this field is used to provide authentication for the user to B-ridge's servers.

The URL of the B-ridge account.

Data Type

string

Default Value

""

Remarks

The URL of the B-ridge account in the form "https://{sample}.azure-api.net".

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
AllowNonKeyColumnInWhereClause	Set the connection property AllowNonKeyColumnInWhereClause as true to execute an update batch without specifying the key columns.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Business b-ridge.
PollingInterval	This determines the polling interval in milliseconds to check whether the result is ready to be retrieved.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
QueryTimeout	The timeout in seconds for requests issued by the provider to process large result sets.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSandbox	Set to true if you want to use user test environment.

Set the connection property AllowNonKeyColumnInWhereClause as true to execute an update batch without specifying the key columns.

Data Type

bool

Default Value

false

Remarks

Set the connection property AllowNonKeyColumnInWhereClause as true to execute an update batch without specifying the key columns.

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 maximum number of records per page the provider returns when requesting data from Business b-ridge.

Data Type

int

Default Value

100

Remarks

When processing a query, instead of requesting all of the queried data at once from Business b-ridge, the Cloud can request the queried data in pieces called pages.

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

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

This determines the polling interval in milliseconds to check whether the result is ready to be retrieved.

Data Type

string

Default Value

"1000"

Remarks

This property determines how long to wait between checking whether or not the query's results are ready. Very large resultsets or complex queries may take longer to process, and a low polling interval may result in many unnecessary requests being made to check the query status.

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:

*=*

The timeout in seconds for requests issued by the provider to process large result sets.

Data Type

int

Default Value

1800

Remarks

If the QueryTimeout property is set to 0, operations will not time out; instead, they will run until they complete successfully or encounter an error condition. This property is distinct from Timeout which applies to individual HTTP operations while QueryTimeout applies to execution time of the operation as a whole.

If QueryTimeout expires and the request has not finished being processed, the Cloud raises an error condition.

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.

Set to true if you want to use user test environment.

Data Type

bool

Default Value

false

Remarks

Set to true if you want to use user test environment.

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.