Adding a Connection to Business b-ridge

To add a connection to Business b-ridge:

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

For required properties, see the Settings tab.

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

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.

This section details a selection of advanced features of the Business b-ridge Sync App.

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

For further information, see Query Processing.

Logging

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

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

Overview

This section shows the available API objects and provides more information on executing SQL to Business b-ridge APIs.

Key Features

• The Sync App 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 Sync App.

Views

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

Tables

The Sync App exposes Tables from Business b-ridge. For every table, Sync App 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 Sync App models the data in Business b-ridge as a list of tables in a relational database that can be queried using standard SQL statements.

Business b-ridge Connector for CData Sync Tables

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

Query information regarding CDATA table.

Select

The Sync App 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.

Business b-ridge Connector for CData Sync 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.

The Sync App 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.

Firewall

---

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

Proxy

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

Property	Description
AllowNonKeyColumnInWhereClause	Set the connection property AllowNonKeyColumnInWhereClause as true to execute an update batch without specifying the key columns.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Business b-ridge, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
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. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
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. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
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.

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.

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.

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.

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.

Remarks

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

This property can take the following forms:

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

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

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

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

---

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

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

Remarks

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

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

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

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

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

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

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

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

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

Remarks

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

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

Remarks

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

For other proxy types, see FirewallType.

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

Remarks

The authentication type can be one of the following:

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

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

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

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

Remarks

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

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

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

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

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

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

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

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

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

---

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

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

Remarks

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

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

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

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

Remarks

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

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

Remarks

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

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

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

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

Remarks

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

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

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

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

---

Property	Description
AllowNonKeyColumnInWhereClause	Set the connection property AllowNonKeyColumnInWhereClause as true to execute an update batch without specifying the key columns.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Business b-ridge, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
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. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
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. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
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.

Remarks

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

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

Remarks

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

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

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

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

Remarks

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

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

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

Remarks

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

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

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. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

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

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

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

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

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 Sync App raises an error condition.

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

Remarks

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

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

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

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

Remarks

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

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

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

Refer to User Defined Views for more information.

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

Remarks

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