Quickbase への接続を追加

Quickbase への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Quickbase アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからQuickbase コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

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.

Other Properties

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

このセクションでは、Quickbase Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Quickbase にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

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

ストアドプロシージャ are function-like interfaces to Quickbase. Stored procedures allow you to execute operations to Quickbase, including downloading documents and moving envelopes.

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 テーブル section, which details standard SQL tables.

Views

The ビュー section, which details standard SQL views.

Stored Procedures

ストアドプロシージャ are actions that are invoked via SQL queries. In the Information schema, they perform operation related to the exposed entities.

Sync App はQuickbase のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Quickbase Connector for CData Sync テーブル

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.

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).

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.

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 ビュー

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.

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.

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.

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.

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 の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにQuickbase から関連するレスポンスデータを返します。

Quickbase Connector for CData Sync ストアドプロシージャ

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.

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.

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.

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. 使用できる値は次のとおりです。NONE, BASE64 デフォルト値は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.

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.

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.

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.

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 使用できる値は次のとおりです。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.

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 の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにQuickbase から関連するレスポンスデータを返します。

Quickbase Connector for CData Sync ストアドプロシージャ

Name	Description

Creates a schema file for the specified table or view.

CreateSchema

データモデル内の既存のテーブルまたはビューからローカルスキーマファイル（.rsd）を作成します。

スキーマファイルは、このプロシージャが実行されると、Location 接続プロパティで設定されたディレクトリに作成されます。ファイルを編集してカラムを含めたり除外したり、カラム名を変更したり、カラムのデータ型を変更したりできます。

Sync App はLocation を確認し、.rsd ファイルの名前がデータモデルのテーブルまたはビューに一致するかどうかを判断します。重複がある場合、スキーマファイルはデータモデル内のこのテーブルのデフォルトインスタンスよりも優先されます。既存のテーブルまたはビューに一致しないスキーマファイルがLocation に存在する場合、新しいテーブルまたはビューのエントリが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.

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.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Quickbase.
Domain	Your Quickbase domain name.
UserToken	The user token used to authenticate the user.
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
ApplicationToken	The application token used to authenticate the user.

Connection

---

プロパティ	説明
Schema	Specify the Quickbase database you want to work with.
IncludeTableReports	Determines if Quickbase table reports should be listed as views.

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
BatchSize	The size of batches to submit when performing a bulk insert/update/delete operation.
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.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreads	Specifies the number of concurrent requests.
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
Pagesize	provider がQuickbase にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDefaultOrderBy	Indicates if a default order by should be applied if none is specified in the query.
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Quickbase.
Domain	Your Quickbase domain name.
UserToken	The user token used to authenticate the user.
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
ApplicationToken	The application token used to authenticate the user.

The type of authentication to use when connecting to Quickbase.

解説

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.

Your Quickbase domain name.

解説

Your Quickbase domain name. Ex: quickbase.com

The user token used to authenticate the user.

解説

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

認証するユーザーのユーザーID を指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

認証するユーザーのパスワードを指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

The application token used to authenticate the user.

解説

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

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。

---

プロパティ	説明
Schema	Specify the Quickbase database you want to work with.
IncludeTableReports	Determines if Quickbase table reports should be listed as views.

Specify the Quickbase database you want to work with.

解説

Specify the Quickbase database you want to work with.

Determines if Quickbase table reports should be listed as views.

解説

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.

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint（hex 値はスペースまたはコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint（hex 値はスペースまたはコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がQuickbase への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がQuickbase への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がQuickbase にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

サポートされる認証の種類：

• BASIC：Sync App はHTTP Basic 認証を行います。
• DIGEST：Sync App はHTTP ダイジェスト認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としないことを示します。

NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Note：Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。

ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。

この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;

デフォルトでは、すべてのモジュールの操作がログに含まれます。

モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP

サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res

Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。

使用可能なモジュールとサブモジュールは次のとおりです。

モジュール名	モジュールの説明	サブモジュール
INFO	一般情報。接続文字列、製品バージョン（ビルド番号）、および初期接続メッセージが含まれます。	Connec — 接続の作成または破棄に関連する情報。 Messag — 接続、接続文字列、製品バージョンに関するメッセージの汎用ラベル。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
EXEC	クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。	Messag — クエリ実行に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Normlz — クエリの正規化ステップ。クエリの正規化とは、ユーザーが送信したクエリを、最適なパフォーマンスで同じ結果を得られるように書き換える処理です。 Origin — ユーザーの元のクエリ（ユーザーが実行した正確で未変更の非正規化クエリ）を記録するメッセージに適用されるラベル。 Page — クエリのページングに関連するメッセージ。 Parsed — クエリの解析ステップ。解析とは、ユーザーが送信したクエリを、処理しやすい標準化された形式に変換するプロセスです。
HTTP	HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス（POST メッセージを含む）、および Kerberos 関連のメッセージが含まれます。	KERB — Kerberos に関連する HTTP リクエスト。 Messag — HTTP プロトコルに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Unpack — サービス API から返された圧縮データを製品が解凍する際のメッセージに適用されるラベル。 Res — HTTP レスポンスを含むメッセージ。 Req — HTTP リクエストを含むメッセージ。
WSDL	WSDL/XSD ファイルの生成に関するメッセージ。	—
SSL	SSL 証明書メッセージ。	Certif — SSL 証明書に関するメッセージ。
AUTH	認証関連の失敗/成功メッセージ。	Messag — 認証に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 OAuth — OAuth 認証に関連するメッセージ。 Krbros — Kerberos 関連の認証メッセージ。
SQL	SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。	Bulk — 一括クエリ実行に関するメッセージ。 Cache — パフォーマンス向上のため、製品のキャッシュへの行データの読み書きに関連するメッセージ。 Messag — SQL トランザクションに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 ResSet — クエリの結果セット。 Transc — 実行されたジョブ数やバックアップテーブルの処理に関する情報を含む、トランザクション処理に関連するメッセージ。
META	メタデータキャッシュとスキーマメッセージ。	Cache — パフォーマンス向上のため、製品のキャッシュ内のカラムおよびテーブル定義の読み取りと変更に関連するメッセージ。 Schema — サービススキーマからのメタデータの取得またはサービススキーマの変更に関連するメッセージ。 MemSto — インメモリメタデータキャッシュへの書き込みまたは読み取りに関連するメッセージ。 Storag — メモリ内ではなく、ディスクまたは外部データストアへのメタデータの保存に関連するメッセージ。
FUNC	SQL 関数の実行に関連する情報。	Errmsg — SQL 関数の実行に関連するエラーメッセージ。
TCP	TCP トランスポートレイヤーメッセージでの送受信生バイト。	Send — TCP プロトコル経由で送信された生データ。 Receiv — TCP プロトコル経由で受信した生データ。
FTP	File Transfer Protocol に関するメッセージ。	Info — FTP プロトコルでの通信に関連するステータスメッセージ。 Client — FTP 通信中に FTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — FTP 通信中に FTP サーバーが実行したアクションに関連するメッセージ。
SFTP	Secure File Transfer Protocol に関するメッセージ。	Info — SFTP プロトコルでの通信に関連するステータスメッセージ。 To_Server — SFTP 通信中に SFTP クライアント（製品）が実行したアクションに関連するメッセージ。 From_Server — SFTP 通信中に SFTP サーバーが実行したアクションに関連するメッセージ。
POP	Post Office Protocol 経由で転送されるデータに関するメッセージ。	Client — POP 通信中に POP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — POP 通信中に POP サーバーが実行したアクションに関連するメッセージ。 Status — POP プロトコルでの通信に関連するステータスメッセージ。
SMTP	Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。	Client — SMTP 通信中に SMTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — SMTP 通信中に SMTP サーバーが実行したアクションに関連するメッセージ。 Status — SMTP プロトコルでの通信に関連するステータスメッセージ。
CORE	他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。	—
DEMN	SQL リモーティングに関連するメッセージ。	—
CLJB	一括データアップロード（クラウドジョブ）に関するメッセージ。	Commit — 一括データアップロードの送信。
SRCE	他のモジュールに属さない、製品が生成するその他のメッセージ。	—
TRANCE	低レベルの製品操作に関する高度なメッセージ。	—

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\QuickBase Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：

プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
BatchSize	The size of batches to submit when performing a bulk insert/update/delete operation.
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.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreads	Specifies the number of concurrent requests.
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
Pagesize	provider がQuickbase にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDefaultOrderBy	Indicates if a default order by should be applied if none is specified in the query.
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

解説

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

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

解説

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

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

Specifies the number of concurrent requests.

解説

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

特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。

解説

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

Note：特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

統合およびフォーマット

プロパティ	説明
DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT=True	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse（ローカルタイムを使用）です。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

provider がQuickbase にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

解説

クエリを処理する際、Quickbase でクエリされたデータすべてを一度にリクエストする代わりに、Sync App はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Sync App がページごとにリクエストする結果の最大数を決定します。

Note：大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にSync App がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

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

解説

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.

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。

次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 次に例を示します。

UserDefinedViews=C:\Path\To\UserDefinedViews.json

UserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。

詳しくは、ユーザー定義ビュー を参照してください。

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.