Quickbase Connector for CData Sync

Build 25.0.9539
  • Quickbase
    • Establishing a Connection
      • Fine-Tuning Data Access
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Information Data Model
        • Tables
          • Apps
          • FieldDefinitions
          • TableDefinitions
        • Views
          • AppVariables
          • FieldPermissions
          • ReportMetadata
          • Users
        • Stored Procedures
          • CreateSolution
          • DeleteFile
          • DownloadFile
          • ExportQBLToRecord
          • GetSolutionQBL
          • ListSolutionChanges
          • ManageGroupMembership
          • UpdateSolution
      • Stored Procedures
        • CreateSchema
        • UploadFile
    • Connection String Options
      • Authentication
        • AuthScheme
        • Domain
        • UserToken
        • User
        • Password
        • ApplicationToken
      • Connection
        • Schema
        • IncludeTableReports
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • BatchSize
        • Charset
        • MaxRows
        • MaxThreads
        • Other
        • Pagesize
        • PseudoColumns
        • Timeout
        • UseDefaultOrderBy
        • UserDefinedViews
    • Third Party Copyrights

Quickbase Connector for CData Sync

Overview

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

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

Quickbase Version Support

The Sync App leverages the Quickbase HTTP API to enable bidirectional access to Quickbase.

Quickbase Connector for CData Sync

Establishing a Connection

Adding a Connection to Quickbase

To add a connection to Quickbase:

  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 Quickbase icon is not available, click the Add More icon to download and install the Quickbase connector from the CData site.

For required properties, see the Settings tab.

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

Authenticating to Quickbase

User Authentication

Set the AuthScheme to Basic to authenticate with this method.

To authenthenticate with user credentials, specify the following connection properties:

  1. Set the Quickbase User and Password.
  2. If your application requires an ApplicationToken, you must provide it otherwise an error will be thrown. You can find the ApplicationToken under MyAppName > Settings > App properties > Advanced settings > Security options > Require Application Tokens > Manage Application Token.

User Token

Set the AuthScheme to Token to authenticate with this method.

To authenthenticate with a user token, specify the following connection properties:

  1. Set UserToken and you are ready to connect. You can find the UserToken under Quick Base > My Preferences > My User Information > Manage User Tokens.

Quickbase Connector for CData Sync

Fine-Tuning Data Access

Other Properties

  • IncludeTableReports: Determines if table reports should be listed as views.

Quickbase Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Quickbase 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 Quickbase 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.

Quickbase Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Quickbase Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

Quickbase Connector for CData Sync

Data Model

Overview

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

Key Features

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

Tables

Tables are automatically determined from the Quickbase.

Views

Views will be listed for table reports if IncludeTableReports is set to true.

Stored Procedures

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

Quickbase Connector for CData Sync

Information Data Model

The Information Schema provides access to metadata entities like tables and fields, enabling users to query Quickbase API objects with SQL. Its data model is composed of three elements: tables, views, and stored procedures.

Tables

The Tables section, which details standard SQL tables.

Views

The Views section, which details standard SQL views.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. In the Information schema, they perform operation related to the exposed entities.

Quickbase Connector for CData Sync

Tables

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

Quickbase Connector for CData Sync Tables

Name Description
Apps Retrieve the main properties of an application.
FieldDefinitions Retrieve the properties for all fields in a specific table.
TableDefinitions Retrieve information for the tables belonging to a given application.

Quickbase Connector for CData Sync

Apps

Retrieve the main properties of an application.

Table Specific Information

Select

The Apps table fetches the primary features of an application.

The Sync App uses the Quickbase API to process search criteria when filtering by the Id column. All other filters are applied client-side within the Sync App.

For example, the following queries are processed server side:

SELECT * FROM [Apps] 
SELECT * FROM [Apps] WHERE [Id] = 'bvadwmxrn';

Insert

The Quickbase Sync App adds a new row to the Apps table with the specified column values.

For example:

INSERT INTO [Apps](Name, Description, AssignToken, SecurityPropertiesAllowClone, SecurityPropertiesAllowExport, SecurityPropertiesEnableAppTokens, SecurityPropertiesHideFromPublic,  SecurityPropertiesMustBeRealmApproved, SecurityPropertiesUseIPFilter, Variables) VALUES('MyApp2', 'app2 description', true, false, false, false, false, true, true, '[{"name":"Variable1","value":"Value1"},{"name":"Variable2","value":"Value2"}]');

Update

The Quickbase Sync App modifies the row in the Apps table, where Id matches the specified value.

For example:

UPDATE [Apps] SET Name='MyAppFromAPI2', Description='Description of MyAppFromAPI2', Variables='[{"name":"Variable1","value":"ValueOfVariable1"},{"name":"Variable3","value":"Value3"}]' WHERE [Id] = 'bvajvby2n'

Note: Updating a non-existing app variable will insert it as a new app variable.

Delete

The Quickbase Sync App removes rows from the Apps table where both the Id and Name match.

For example:

DELETE FROM [Apps] WHERE [Id] = 'bvajvby2n' AND [Name] = 'MyAppFromAPI2'

Columns

Name Type ReadOnly References SupportedOperators Description
Id [KEY] String True =

The unique identifier for this application.

Name String False =

The name of the application.

Description String False

The description of the application.

TimeZone String True

The time zone used when displaying time values in this application.

DateFormat String True

The format used for displaying date values in the application.

Created Datetime True

The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).

Updated Datetime True

The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).

DataClassification String True

The data classification label assigned to the application.

HasEveryoneOnTheInternet Boolean True

Indicates if the application is accessible to everyone on the internet.

MemoryInfoEstMemory Int64 True

The estimated memory usage of the application in gigabytes.

MemoryInfoEstMemoryInclDependentApps Int64 True

The estimated memory usage including dependent applications in gigabytes.

SecurityPropertiesAllowClone Boolean False

Indicates if non-admin users can clone the application.

SecurityPropertiesAllowExport Boolean False

Indicates if non-admin users can export data from the application.

SecurityPropertiesEnableAppTokens Boolean False

Indicates if application tokens are required.

SecurityPropertiesHideFromPublic Boolean False

Indicates if the application is hidden from public searches.

SecurityPropertiesMustBeRealmApproved Boolean False

Indicates if only realm-approved users can access the application.

SecurityPropertiesUseIPFilter Boolean False

Indicates if access is restricted to approved IP addresses.

Variables String False

Variables available in this application.

AncestorId String True

Apps.Id

The Id of the source application from which this one was copied.

Pseudo-Columns

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

Name Type Description
AssignToken Boolean

Indicates if the application should be assigned to the user token used during creation (default: false).

Quickbase Connector for CData Sync

FieldDefinitions

Retrieve the properties for all fields in a specific table.

Table Specific Information

Select

The FieldDefinitions table gathers the detailed attributes for each field within a designated table.

The Sync App retrieves field definitions from the FieldDefinitions table, accessing either all records pertaining to a table or a specific record when multiple criteria are applied. All other filters are executed client-side within the Sync App.

For example, the following queries are processed server side:

SELECT * FROM [FieldDefinitions] WHERE [TableId] = 'bvajv8gg2'
SELECT * FROM [FieldDefinitions] WHERE [Id] = '1' AND [TableId] = 'bvady68q6'

Insert

The Quickbase Sync App inserts a new record into the FieldDefinitions table, creating a new field definition.

For example:

INSERT INTO FieldDefinitions(Label, FieldType, NoWrap, Bold, AppearsByDefault, FindEnabled, FieldHelp, MaxLength, AppendOnly, SortAsGiven, Permissions, TableId) VALUES('Field1', 'text', false, false, false, true, 'field1 help', 0, false, false, '[{"role":"Viewer","permissionType":"View","roleId":10},{"role":"Participant","permissionType":"None","roleId":11},{"role":"Administrator","permissionType":"Modify","roleId":12}]', 'bvajv8gg2')

Update

The Quickbase Sync App updates an existing record in the FieldDefinitions table, modifying one or more properties of a field definition identified by specific criteria.

For example:

UPDATE FieldDefinitions SET Label='UpdatedField1' WHERE [Id] = '6' AND [TableId] = 'bvajv8gg2'

Delete

The Quickbase Sync App deletes a record from the FieldDefinitions table that matches the specified identifying criteria.

For example:

DELETE FROM [FieldDefinitions] WHERE [Id] = '6' AND [TableId] = 'bvajv8gg2'

Columns

Name Type ReadOnly References SupportedOperators Description
Id [KEY] Int64 False =

The Id of the field, unique to this table.

FieldType String False

The type of field.

Mode String True

For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.

Label String False

The label (name) of the field.

NoWrap Boolean False

Indicates if the field is configured to not wrap when displayed in the product.

Bold Boolean False

Indicates if the field is configured to display in bold in the product.

Required Boolean False

Indicates if the field is marked required.

AppearsByDefault Boolean False

Indicates if the field is marked as a default in reports.

FindEnabled Boolean False

Indicates if the field is marked as searchable.

Unique Boolean False

Indicates if the field is marked unique.

DoesDataCopy Boolean True

Indicates if the field data will copy when a user copies the record.

FieldHelp String False

The configured help text shown to users within the product.

Audited Boolean False

Indicates if the field is being tracked as part of Quickbase Audit Logs.

AllowMentions Boolean False

If someone can @mention users in the rich text field to generate an email notification.

Comments String False

The comments entered on the field properties by an administrator.

DoesTotal Boolean False

Whether this field totals in reports within the product.

AutoSave Boolean False

Whether the link field will auto save.

DefaultValueLuId Int64 False

Default user Id value.

UseI18NFormat Boolean False

Whether phone numbers should be in E.164 standard international format.

MaxVersions Int64 False

The maximum number of versions configured for a file attachment.

CarryChoices Boolean False

Whether the field should carry its multiple choice fields when copied.

Format Int64 False

The format to display time.

MaxLength Int64 False

The maximum number of characters allowed for entry in Quickbase for this field.

LinkText String False

The configured text value that replaces the URL that users see within the product.

ParentFieldId Int64 False

The Id of the parent composite field, when applicable.

DisplayTimezone Boolean False

Indicates whether to display the timezone within the product.

SummaryTargetFieldId Int64 True

The Id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn't require a field selection (like count).

AllowNewChoices Boolean False

Indicates if users can add new choices to a selection list.

MasterChoiceFieldId Int64 True

The Id of the field that is the reference in the relationship.

DefaultToday Boolean False

Indicates if the field value is defaulted today for new records.

Units String False

The units label.

LookupTargetFieldId Int64 True

The Id of the field that is the target on the master table for this lookup.

SummaryFunction String True

The summary accumulation function type.

SourceFieldId Int64 False

The Id of the source field.

MasterTableTag String True

The table alias for the master table in the relationship this field is part of.

DoesAverage Boolean False

Whether this field averages in reports within the product.

Formula String False

The formula of the field as configured in Quickbase.

DecimalPlaces Int64 False

The number of decimal places displayed in the product for this field.

DefaultCountryCode String False

Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.

SeeVersions Boolean False

Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.

DisplayMonth String False

Indicates how months should be displayed.

NumLines Int64 False

The number of lines shown in Quickbase for this text field.

DisplayEmail String False

Indicates how email should be displayed.

DefaultKind String False

The user default type.

CoverText String False

An alternate user friendly text that can be used to display a link in the browser.

CurrencySymbol String False

The current symbol used when displaying field values within the product.

MasterChoiceTableId String False

The Id of the table that is the master in this relationship.

TargetFieldId Int64 False

The Id of the target field.

DisplayUser String False

The configured option for how users display within the product.

BlankIsZero Boolean False

Whether a blank value is treated the same as 0 in calculations within the product.

Exact Boolean False

Whether an exact match is required for a report link.

StartField Int64 False

The start field Id.

DefaultDomain String False

Default email domain.

DefaultValue String False

The default value configured for a field when a new record is added.

ChoicesLuId String False

List of user choices.

Abbreviate Boolean False

Displays the URL without the protocol.

XmlTag String True

The field's xml tag.

TargetTableName String False

The field's target table name.

NumberFormat Int64 False

The format used for displaying numeric values in the product (decimal, separators, digit group).

AppearsAs String False

The link text, if empty, the url will be used as link text.

Width Int64 False

The field's html input width in the product.

CurrencyFormat String False

The currency format used when displaying field values within the product.

ForeignKey Boolean False

Indicates if the field is a foreign key (or reference field) in a relationship.

DisplayDayOfWeek Boolean False

Indicates whether to display the day of the week within the product.

SummaryReferenceFieldId Int64 True

The Id of the field that is the reference in the relationship for this summary.

CommaStart Int64 False

The number of digits before commas display in the product, when applicable.

Choices String False

An array of entries that exist for a field that offers choices to the user.

TargetTableId String False =

The Id of the target table.

DisplayRelative Boolean False

Whether to display time as relative.

CompositeFields String False

An array of the fields that make up a composite field (e.g., address).

DisplayCheckboxAsText Boolean False

Indicates whether the checkbox values will be shown as text in reports.

VersionMode String False

Version modes for files.

DisplayTime Boolean False

Indicates whether to display the time, in addition to the date.

DurationField Int64 True

The duration field id.

SnapFieldId Int64 False

The Id of the field that is used to snapshot values from, when applicable.

Hours24 Boolean False

Indicates whether or not to display time in the 24-hour format within the product.

SortAlpha Boolean False

Whether to sort alphabetically, default sort is by record Id.

SortAsGiven Boolean False

Indicates if the listed entries sort as entered vs alphabetically.

HasExtension Boolean False

Whether this field has a phone extension.

WorkWeek Int64 True

The work week type.

UseNewWindow Boolean False

Indicates if the URL should open a new window when a user clicks it within the product.

AppendOnly Boolean False

Indicates whether the field is append-only.

DisplayAsLink Boolean False

Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.

AllowHTML Boolean False

Indicates whether HTML content is allowed in this field.

LookupReferenceFieldId Int64 False

The Id of the field that is the reference in the relationship for this lookup.

Permissions String False

Field Permissions for different roles.

TableId [KEY] String False

TableDefinitions.Id

=

The unique identifier (dbid) of the table.

Quickbase Connector for CData Sync

TableDefinitions

Retrieve information for the tables belonging to a given application.

Table Specific Information

Select

The TableDefinitions table gathers detailed information regarding the tables associated with a specific application. This involves retrieving metadata related to the entity, such as the table description, its storage space, and timezone information.

The Sync App uses the Quickbase API to retrieve TableDefinitions either for an entire application (by AppId) or for a specific table within that application (by Id and AppId). All other filters are applied client-side within the Sync App.

For example, the following queries are processed server side:

SELECT * FROM [TableDefinitions] WHERE [AppId] = 'bu99sj2wn'
SELECT * FROM [TableDefinitions] WHERE [Id] = 'bu99sj2wu' AND [AppId] = 'bu99sj2wn'

Insert

The Quickbase Sync App inserts a new row into the TableDefinitions table, creating a table definition with the specified name, description, record names, and associated AppId.

For example:

INSERT INTO TableDefinitions(Name, Description, SingleRecordName, PluralRecordName, AppId) VALUES('tableFromAPI1', 'description1', 'record', 'records', 'bvajvby2n')

Update

The Quickbase Sync App updates an existing row in the TableDefinitions table identified by the Id field while modifying its values.

For example:

UPDATE TableDefinitions Name='UpdatedTableUsingAPI1', Description='Updated description for UpdatedTableUsingAPI1' WHERE [Id] = 'bvajv8gg2' AND AppId = 'bvajvby2n'

Delete

The Quickbase Sync App deletes a row from the TableDefinitions table identified by the Id field based on specified criteria.

For example:

DELETE FROM [TableDefinitions] WHERE [Id] = 'bvajv8gg2' AND [AppId] = 'bvajvby2n'

Columns

Name Type ReadOnly References SupportedOperators Description
Id [KEY] String True =

The unique identifier (dbid) of the table.

Name String False

The name of the table.

Alias String True

The automatically-created table alias for the table.

Description String False

The description of the table, as configured by an application administrator.

Created Datetime True

The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).

Updated Datetime True

The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).

NextRecordId Int64 True

The incremental Record Id that will be used when the next record is created, as determined when the API call was ran.

NextFieldId Int64 True

The incremental Field Id that will be used when the next field is created, as determined when the API call was ran.

DefaultSortFieldId Int64 True

The id of the field that is configured for default sorting.

DefaultSortOrder String True

The configuration of the default sort order on the table.

KeyFieldId Int64 True

The id of the field that is configured to be the key on this table, which is usually the Quickbase Record Id.

SingleRecordName String False

The builder-configured singular noun of the table.

PluralRecordName String False

The builder-configured plural noun of the table.

SizeLimit String True

The size limit for the table.

SpaceUsed String True

The amount of space currently being used by the table.

SpaceRemaining String True

The amount of space remaining for use by the table.

AppId String True

Apps.Id

=

The unique identifier for this application.

Quickbase Connector for CData Sync

Views

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

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

Quickbase Connector for CData Sync Views

Name Description
AppVariables Retrieve the application variables.
FieldPermissions Retrieve role-specific field permission.
ReportMetadata Retrieve the schema (properties) of a table's reports.
Users Retrieve all users in an account.

Quickbase Connector for CData Sync

AppVariables

Retrieve the application variables.

Table Specific Information

Select

The AppVariables view accesses and gathers the various application variables to ensure all relevant data is retrieved for function and analysis.

The Sync App fetches all application variables linked to a specified application from the AppVariables view. Other filters are executed client-side within the Sync App.

For example, the following query is processed server side:

SELECT * FROM [AppVariables] WHERE [AppId] = 'bu99sj2wn'

Columns

Name Type References SupportedOperators Description
Name [KEY] String The name of the variable.
Value String The value assigned to the variable.
AppId [KEY] String

Apps.Id

= The unique identifier for this application.

Quickbase Connector for CData Sync

FieldPermissions

Retrieve role-specific field permission.

Table Specific Information

Select

The FieldPermissions view obtains the permissions for specific fields based on the designated role.

The Sync App provides details about the fields of a specific table, retrieving all field definitions and obtaining permissions for a particular field. Other filters are executed client-side within the Sync App.

For example, the following queries are processed server side:

SELECT * FROM [FieldPermissions] WHERE [TableId] = 'bvady68q6'
SELECT * FROM [FieldPermissions] WHERE [FieldId] = 6 AND [TableId] = 'bvady68q6'

Columns

Name Type References SupportedOperators Description
PermissionRoleId String The Id of the role assigned to the permission.
PermissionAssociatedRole String The role linked to the permission for the field.
PermissionType String The type of permission granted to the role for the field.
FieldId Int64

FieldDefinitions.Id

= The unique Id of the field within the table.
TableId String

TableDefinitions.Id

= The unique identifier (dbid) of the table.

Quickbase Connector for CData Sync

ReportMetadata

Retrieve the schema (properties) of a table's reports.

Table Specific Information

Select

The ReportMetadata view fetches information about all available reports in Quickbase.

The Sync App retrieves report metadata from the ReportMetadata view, either returning all metadata associated with a given table or retrieving a specific report's metadata within that table when additional criteria are applied. All other filters are executed client-side within the Sync App.

For example, the following queries are processed server side:

SELECT * FROM [ReportMetadata] WHERE [TableId] = 'bu99sj2wz';
SELECT * FROM [ReportMetadata] WHERE [TableId] = 'bu99sj2wz' AND [ReportId] = '52';

Columns

Name Type References SupportedOperators Description
ReportId String = The identifier of the report, unique to the table.
Name String The configured name of the report.
Type String The type of report in Quickbase.
Description String The configured description of a report.
OwnerId Int64 The user Id of report owner. Optional, showed only for personal reports.
QueryFilter String Filter criteria applied in the query to retrieve report data.
QueryFormulaFields String Formula-based fields included in the query results.
Properties String A list of properties specific to the report type.
UsedLast String The instant at which a report was last used.
UsedCount Int64 The number of times a report has been used.
TableId String

TableDefinitions.Id

= The table identifier used in the query when the report is executed.

Quickbase Connector for CData Sync

Users

Retrieve all users in an account.

Table Specific Information

Select

The User view gathers a comprehensive list of all users associated with a specific account.

The Sync App uses the Quickbase API to process filters on EmailAddress, AccountId, or AppIds. Other filters are processed client-side.

For example, the following queries are processed server side:

SELECT * FROM [Users]
SELECT * FROM [Users] WHERE [EmailAddress] IN ('[email protected]', '[email protected]')
SELECT * FROM [Users] WHERE [AccountId] = 1
SELECT * FROM [Users] WHERE [AppIds] IN ('bu99sj2wn', 'bvadwmxrn')

Columns

Name Type References SupportedOperators Description
HashId [KEY] String The hashId of the user.
UserName String The username of the user.
FirstName String The first name of the user.
LastName String The last name of the user.
EmailAddress String =,IN The email address of the user.

Pseudo-Columns

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

Name Type Description
AccountId Int64 The account id being used to get users. If no value is specified, the first account associated with the requesting user token is chosen.
AppIds String When provided, the returned users will be narrowed down only to the users assigned to the app id's provided in this list. The provided app id's should belong to the same account.

Quickbase Connector for CData Sync

Stored Procedures

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

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

Quickbase Connector for CData Sync Stored Procedures

Name Description
CreateSolution Create a solution using either the provided QBL or the stored QBL from the specified record.
DeleteFile Deletes one file attachment's version.
ExportQBLToRecord Exports a QBL solution, creating a new record in the specified table. It exports the solution and outputs the resulting QBL in a new record, saving the QBL to a file in the designated file attachment field. The target table must not have required fields other than the file attachment field.
GetSolutionQBL Retrieves the QBL of solution.
ListSolutionChanges Returns a list of changes that would occur if the provided QBL or the QBL from the record were applied.
ManageGroupMembership Adds or removes a list of users to a given group as members.
UpdateSolution Updates the solution using the provided QBL or the QBL stored in the specified record.

Quickbase Connector for CData Sync

CreateSolution

Create a solution using either the provided QBL or the stored QBL from the specified record.

Input

Name Type Required Description
QBL String False QBL to create the solution from. This field is required when TableId/FieldId/RecordId are missing. If they're specified as well, it takes precedence.
TableId String False The unique identifier (dbid) of the table where the QBL file attachment is stored. This field is required when QBL is missing.
FieldId Int64 False The unique identifier (fid) of the field where the QBL file attachment is stored. It needs to be a file attachment field. This field is required when QBL is missing.
RecordId Int64 False The unique identifier of the record where the QBL file attachment is stored. This field is required when QBL is missing.

Result Set Columns

Name Type Description
Success Boolean Whether the operation is successful or not.
ErrorMessage String Error message or details if any.
Alias String The the alias of the new solution created solution.
SolutionId String The Id of the new solution created.
CreatedResourcesApps String The apps created in the solution.
CreatedResourcesPipelines String The pipelines created in the solution.
Warnings String Warnings generated during the execution of the operation.

Quickbase Connector for CData Sync

DeleteFile

Deletes one file attachment's version.

Input

Name Type Required Description
TableId String True The unique identifier (dbid) of the table where the attachment is stored.
FieldId Int64 True The unique identifier (fid) of the field where the attachment is stored. It needs to be a file attachment field.
RecordId Int64 True The unique identifier of the record where the attachment is stored.
VersionNumber Int64 True The file attachment version number.

Result Set Columns

Name Type Description
Success Boolean Whether the operation is successful or not.
ErrorMessage String Error message or details if any.
VersionNumber Int64 The file attachment version number deleted.
FileName String The name of file associated with deleted version.
Uploaded Datetime The timestamp when the version was originally uploaded.
CreatorId String The id of the user who uploaded that version.
CreatorName String The full name of the user who uploaded that version.
CreatorUserName String The user name of the user who uploaded that version. Optional, appears if not the same as user email.
CreatorEmail String The email of the user who uploaded that version.

Quickbase Connector for CData Sync

DownloadFile

Download the file attachment specified in the record.

Input

Name Type Required Description
TableId String True The unique identifier (dbid) of the table where the attachment is stored.
FieldId Int64 True The unique identifier (fid) of the field where the attachment is stored. It needs to be a file attachment field.
RecordId Int64 True The unique identifier of the record where the attachment is stored.
VersionNumber Int64 True The file attachment version number.
Encoding String False The FileData input encoding type. The allowed values are NONE, BASE64.

The allowed values are NONE, BASE64.

The default value is BASE64.

FileLocation String False Path to save the downloaded file. If a file exists, a new name is generated. If a directory, uses the original file name.

Result Set Columns

Name Type Description
Success Boolean Whether the operation is successful or not.
ErrorMessage String Error message or details if any.
FileData String The content of the file, if the FileLocation or FileStream input is empty.
FileName String The name of the file where content is downloaded.

Quickbase Connector for CData Sync

ExportQBLToRecord

Exports a QBL solution, creating a new record in the specified table. It exports the solution and outputs the resulting QBL in a new record, saving the QBL to a file in the designated file attachment field. The target table must not have required fields other than the file attachment field.

Input

Name Type Required Description
SolutionId String True The unique identifier (UUID) or the alias of the solution.
TableId String True The unique identifier (dbid) of the table to store the QBL as file attachment.
FieldId Int64 True The unique identifier (fid) of the field. It needs to be a file attachment field.

Result Set Columns

Name Type Description
Success Boolean Whether the operation is successful or not.
ErrorMessage String Error message or details if any.
RecordId Int64 The record Id created where the QBL file attachment is stored.
FileName String The name of the file, where QBL is stored.

Quickbase Connector for CData Sync

GetSolutionQBL

Retrieves the QBL of solution.

Input

Name Type Required Description
SolutionId String True The unique identifier (UUID) or the alias of the solution.

Result Set Columns

Name Type Description
Success Boolean Whether the operation is successful or not.
ErrorMessage String Error message or details if any.
QBL String The QBL of the specified input solution.

Quickbase Connector for CData Sync

ListSolutionChanges

Returns a list of changes that would occur if the provided QBL or the QBL from the record were applied.

Input

Name Type Required Description
SolutionId String True The unique ID (UUID) or alias of the solution to which the QBL may be applied.
QBL String False The QBL to use for the changeset. This input is required if TableId, FieldId, and RecordId are not provided. If those fields are specified, QBL takes precedence.
TableId String False The unique identifier (dbid) of the table where the QBL file attachment is stored. This field is required when QBL is missing.
FieldId Int64 False The unique identifier (fid) of the field where the QBL file attachment is stored. It needs to be a file attachment field. This field is required when QBL is missing.
RecordId Int64 False The unique identifier of the record where the QBL file attachment is stored. This field is required when QBL is missing.

Result Set Columns

Name Type Description
Success Boolean Whether the operation is successful or not.
ErrorMessage String Error message or details if any.
Id String The Id of the operation.
ChangeLogicalType String The logical type of the change.
ChangeLogicalId String The logical Id of the change.
ChangeAction String The action of change.
ChangePath String The path of the change.

Quickbase Connector for CData Sync

ManageGroupMembership

Adds or removes a list of users to a given group as members.

Procedure Specific Information

The Sync App executes the ManageGroupMembership stored procedure, which adds or removes users to update group membership.

For example:

EXEC [ManageGroupMembership] [GroupId] = '122789', [UserHashIDs] = '100000.be8s, 123456.ryyw, 423123.b3x5', [Mode] = 'remove';
EXEC [ManageGroupMembership] [GroupId] = '122789', [UserHashIDs] = '100000.be8s, 123456.ryyw, 423123.b3x5', [Mode] = 'add';

Input

Name Type Required Description
GroupId Int64 True This is the ID of the group being modified.
UserHashIDs String True A list of user HashIDs that will be added to a group.
Mode String True Specify whether you want to add or remove members from the group

The allowed values are add, remove.

Result Set Columns

Name Type Description
Success String Shows if the download finished successfully.
UnprocessedUserId String Users that couldn't be added to the group. This represent an invalid user or user who is already been added to the group.
ProcessedUserId String User that is added to the group successfully.

Quickbase Connector for CData Sync

UpdateSolution

Updates the solution using the provided QBL or the QBL stored in the specified record.

Input

Name Type Required Description
SolutionId String True The unique identifier (UUID) or the alias of the solution.
QBL String False The QBL to use for the update. This field is required when TableId/FieldId/RecordId are missing. If these are specified, this value takes precedence.
TableId String False The unique identifier (dbid) of the table where the QBL file attachment is stored. This field is required when QBL is missing.
FieldId Int64 False The unique identifier (fid) of the field where the QBL file attachment is stored. This field is required when QBL is missing.
RecordId Int64 False The unique identifier of the record where the QBL file attachment is stored. This field is required when QBL is missing.

Result Set Columns

Name Type Description
Success Boolean Whether the operation is successful or not.
ErrorMessage String Error message or details if any.
Alias String The alias of the updated solution.
SolutionId String The Id of the solution updated.
CreatedResourcesApps String The apps created in the solution during the update.
Warnings String Warnings generated during the execution of the update operation.

Quickbase Connector for CData Sync

Stored Procedures

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

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

Quickbase Connector for CData Sync Stored Procedures

Name Description

Quickbase Connector for CData Sync

CreateSchema

Creates a schema file for the specified table or view.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The Sync App checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the Sync App.

Input

Name Type Required Description
SchemaName String False The schema name for which to list tables or views.
TableName String True The name of the table or view.
FileName String False The full file path and name of the schema to generate. Ex: 'C:\\Users\\User\\Desktop\\QuickBase\\Customers.rsd'

Result Set Columns

Name Type Description
Result String Returns Success or Failure.
FileData String File data that will be outputted encoded in Base64 if the FileName and FileStream inputs are not set.

Quickbase Connector for CData Sync

UploadFile

Upload file attachments in Quick Base.

Input

Name Type Required Description
SchemaName String True The schema where the attachment field is located.
TableName String True The table where the attachment field is located.
FieldName String True The name of the attachment field.
RecordId String True The id of the record that will contain the file attachment.
FileData String False A string of data that will be used as the full contents of the file. This must be base-64 encoded. Required if LocalFile or Content are not specified.
LocalFile String False The local file path including the file name of the file to be uploaded. A value for this field is required when FileData or Content are not specified.
FileName String False The name you would like to give the document. If none is specified, the file name specified in the FullPath will be used. Required if FileData or Content is specified.

Result Set Columns

Name Type Description
Success Boolean Whether or not the operation was successful.
URL String The URL of the file attachment.

Quickbase Connector for CData Sync

Connection String Options

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

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

Authentication


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to Quickbase.
DomainYour Quickbase domain name.
UserTokenThe user token used to authenticate the user.
UserSpecifies the authenticating user's user ID.
PasswordSpecifies the authenticating user's password.
ApplicationTokenThe application token used to authenticate the user.

Connection


PropertyDescription
SchemaSpecify the Quickbase database you want to work with.
IncludeTableReportsDetermines if Quickbase table reports should be listed as views.

SSL


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

Firewall


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

Proxy


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

Logging


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

Schema


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

Miscellaneous


PropertyDescription
BatchSizeThe size of batches to submit when performing a bulk insert/update/delete operation.
CharsetSpecifies the session character set for encoding and decoding character data transferred to and from the Quickbase API. The default value is UTF-8.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreadsSpecifies the number of concurrent requests.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Quickbase.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseDefaultOrderByIndicates if a default order by should be applied if none is specified in the query.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
Quickbase Connector for CData Sync

Authentication

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


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to Quickbase.
DomainYour Quickbase domain name.
UserTokenThe user token used to authenticate the user.
UserSpecifies the authenticating user's user ID.
PasswordSpecifies the authenticating user's password.
ApplicationTokenThe application token used to authenticate the user.
Quickbase Connector for CData Sync

AuthScheme

The type of authentication to use when connecting to Quickbase.

Remarks

The type of authentication to use when connecting to Quickbase.

  • Basic: Set this to use BASIC user / password authentication.
  • Token: Set this to perform Token Based Authentication.

Quickbase Connector for CData Sync

Domain

Your Quickbase domain name.

Remarks

Your Quickbase domain name. Ex: quickbase.com

Quickbase Connector for CData Sync

UserToken

The user token used to authenticate the user.

Remarks

This value may be specified instead of User and Password to authenticate.

Quickbase Connector for CData Sync

User

Specifies the authenticating user's user ID.

Remarks

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

Quickbase Connector for CData Sync

Password

Specifies the authenticating user's password.

Remarks

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

Quickbase Connector for CData Sync

ApplicationToken

The application token used to authenticate the user.

Remarks

Used along with User, Password to authenticate with the server.

Quickbase Connector for CData Sync

Connection

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


PropertyDescription
SchemaSpecify the Quickbase database you want to work with.
IncludeTableReportsDetermines if Quickbase table reports should be listed as views.
Quickbase Connector for CData Sync

Schema

Specify the Quickbase database you want to work with.

Remarks

Specify the Quickbase database you want to work with.

Quickbase Connector for CData Sync

IncludeTableReports

Determines if Quickbase table reports should be listed as views.

Remarks

If this property is set to False, table-based reports are excluded from the API response.

When IncludeTableReports is set to True, almost all report types become accessible through the API, except for Kanban reports. However, the API will only return the columns that a user can see in the user interface. Any hidden columns will not appear in the report's metadata or results.

Quickbase Connector for CData Sync

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Quickbase Connector for CData Sync

SSLServerCert

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

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

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

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

Quickbase Connector for CData Sync

Firewall

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


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

FirewallType

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

Remarks

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

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

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

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

Protocol Default Port Description
TUNNEL 80 The port where the Sync App opens a connection to Quickbase. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Quickbase. 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 Quickbase. 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.

Quickbase Connector for CData Sync

FirewallServer

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

Remarks

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

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

Quickbase Connector for CData Sync

FirewallPort

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

Remarks

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

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

Quickbase Connector for CData Sync

FirewallUser

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

Remarks

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

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

Quickbase Connector for CData Sync

FirewallPassword

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

Remarks

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

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

Quickbase Connector for CData Sync

Proxy

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


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

ProxyAutoDetect

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

Remarks

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

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

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

Quickbase Connector for CData Sync

ProxyServer

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

Remarks

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

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

Quickbase Connector for CData Sync

ProxyPort

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

Remarks

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

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

For other proxy types, see FirewallType.

Quickbase Connector for CData Sync

ProxyAuthScheme

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

Remarks

Supported authentication types :

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

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

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

Quickbase Connector for CData Sync

ProxyUser

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

Remarks

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

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

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

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

Quickbase Connector for CData Sync

ProxyPassword

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

Quickbase Connector for CData Sync

ProxySSLType

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

Remarks

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

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

Quickbase Connector for CData Sync

ProxyExceptions

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

Remarks

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

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

Quickbase Connector for CData Sync

Logging

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


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

LogModules

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

Remarks

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

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

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

By default, logged operations from all modules are included.

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

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

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

The available modules and submodules are:

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

Quickbase Connector for CData Sync

Schema

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


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

Location

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

Remarks

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

If left unspecified, the default location is %APPDATA%\\CData\\QuickBase 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

Quickbase Connector for CData Sync

BrowsableSchemas

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

Remarks

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

Quickbase Connector for CData Sync

Tables

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

Remarks

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

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

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

Quickbase Connector for CData Sync

Views

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

Remarks

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

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

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

Quickbase Connector for CData Sync

Miscellaneous

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


PropertyDescription
BatchSizeThe size of batches to submit when performing a bulk insert/update/delete operation.
CharsetSpecifies the session character set for encoding and decoding character data transferred to and from the Quickbase API. The default value is UTF-8.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreadsSpecifies the number of concurrent requests.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Quickbase.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseDefaultOrderByIndicates if a default order by should be applied if none is specified in the query.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
Quickbase Connector for CData Sync

BatchSize

The size of batches to submit when performing a bulk insert/update/delete operation.

Remarks

This connection property controls how many records will be submitted to the Quickbase at a time when performing mass inserts and update operations.

Quickbase Connector for CData Sync

Charset

Specifies the session character set for encoding and decoding character data transferred to and from the Quickbase API. The default value is UTF-8.

Remarks

Specifies the session character set for encoding and decoding character data transferred to and from the Quickbase API. The default value is UTF-8.

Quickbase Connector for CData Sync

MaxRows

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

Remarks

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

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

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

Quickbase Connector for CData Sync

MaxThreads

Specifies the number of concurrent requests.

Remarks

This property allows you to issue multiple requests simultaneously, thereby improving performance.

Quickbase Connector for CData Sync

Other

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

Remarks

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

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

Integration and Formatting

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

Quickbase Connector for CData Sync

Pagesize

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

Remarks

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

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

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

Quickbase Connector for CData Sync

PseudoColumns

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

Remarks

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

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Quickbase Connector for CData Sync

Timeout

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

Remarks

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

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

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

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

Quickbase Connector for CData Sync

UseDefaultOrderBy

Indicates if a default order by should be applied if none is specified in the query.

Remarks

By default, the CData Sync App applies an order by when none is specified. This ensures that duplicate records do not get output when returning data. However, this will have a significant impact on performance for very large tables. If your use case can handle the possibility of duplicate primary keys, it is recommended to turn this off if you would like to have better performance.

Quickbase Connector for CData Sync

UserDefinedViews

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

Remarks

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

For example:

{
	"MyView": {
		"query": "SELECT * FROM [CData].[QuickBase].SampleTable_1 WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

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

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

For further information, see User Defined Views.

Quickbase Connector for CData Sync

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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

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