CData Sync App は、Highrise データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Highrise コネクタはCData Sync アプリケーションから使用可能で、Highrise からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はHighrise REST API を使用しています。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Highrise はOAuth 認証標準を利用しています。Highrise へ認証するには、OAuthClientId、OAuthClientSecret、およびCallbackURL を取得する必要があります。
すべてのOAuth フローで、AuthScheme をOAuth に設定する必要があります。以下のセクションは、すでに設定済みであることを前提として書かれています。
API トークンでHighrise へ認証するには、以下を設定します。
このセクションでは、Highrise Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App は、Highrise API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。 Sync App は、Highrise API を使用してサポートされているフィルタを処理します。その他のフィルタは、Sync App 内でクライアント側で処理されます。
CData Sync App は、書き込み可能なHighrise API をアクセスしやすいテーブル にモデル化します。ほとんどのテーブルは、シンプルなテキストベースのスキーマファイルにより定義されています。 ただし、Companies、Deals、およびPeople などのテーブルは動的にスキーマ定義されます。接続時にSync App は、適切なWeb サービスを呼び出して動的にテーブルのメタデータを取得します。
ビュー は読み取り専用のテーブルです。通常は、変更ができないデータはビューとして表されます。
Sync App は、ストアドプロシージャ を利用可能にし、Highrise のファンクションライクなインターフェースにより、API の追加の機能を利用可能にします。
Sync App はHighrise のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Cases | Create, update, delete, and query Cases that are visible to the authenticated user. |
| Comments | Create, update, delete, and query Comments associated with a Note or Email and visible to the authenticated user. |
| Companies | Create, update, delete, and query Highrise Companies. This table is dynamic. |
| CustomFields | Return all custom fields used in the account. |
| DealCategories | Create, update, delete, and query Deal Categories. |
| Deals | Create, update, delete, and query Highrise Deals. This table is dynamic. |
| Groups | Query, create, update and delete your account's groups |
| Notes | Create, update, delete, and query Notes that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal. |
| People | Create, update, delete, and query Highrise People. This table is dynamic. |
| TaskCategories | Create, update, delete, and query Task Categories. |
Create, update, delete, and query Cases that are visible to the authenticated user.
新しいCase を挿入するには、Name が必要です。
INSERT INTO Cases (Name) VALUES ('my case')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier for the case. | |
| Name | String | False |
The name of the case. | |
| IsClosed | Boolean | True |
Whether the case is closed. The default is open. | |
| ClosedAt | Datetime | False |
The date and time when the case was closed. | |
| VisibleTo | String | False |
Who the case is visible to: Everyone, Owner, or NamedGroup. | |
| OwnerId | Integer | False |
The unique identifier of the owner. | |
| GroupId | Integer | False |
The unique identifier of the group. | |
| AuthorId | Integer | False |
The unique identifier of the author. | |
| CreatedAt | Datetime | True |
The date and time when the case was created. | |
| UpdatedAt | Datetime | True |
The date and time when the case was last updated. | |
| Parties | String | True |
The parties of the case. |
Create, update, delete, and query Comments associated with a Note or Email and visible to the authenticated user.
Comments の取得には、Notes およびEmails などのNote が所属するSebjectType およびSubject Id を入力します。
SELECT * FROM Comments WHERE SubjectType = 'notes' AND SubjectId = '351922361'
Comment の挿入には、次のクエリを入力します。Common Body およびParentId は必須です。
INSERT INTO Comments (Body, ParentId) VALUES ('me comment', '351199012')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the comment. | |
| Body | String | False |
The body of the comment. | |
| ParentId | Integer | False |
The Id of the parent of the comment. | |
| SubjectId | Integer | True |
The Id of the subject of the comment. | |
| SubjectType | String | True |
The subject type of the comment. | |
| SubjectName | String | True |
The subject name of the comment. | |
| CollectionId | Integer | True |
The Id of the collection. | |
| CollectionType | String | True |
The type of the collection. | |
| VisibleTo | String | True |
Who the comment is visible to: Everyone, Owner, or NamedGroup. | |
| GroupId | Integer | True |
The Id of the group. | |
| OwnerId | Integer | True |
The Id of the owner. | |
| AuthorId | Integer | True |
The Id of the author of the comment. | |
| CreatedAt | Datetime | True |
The date and time when the comment was created. | |
| UpdatedAt | Datetime | True |
The date and time when the comment was last updated. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| ParentType | String |
Whether the comment is associated with a note or email. 使用できる値は次のとおりです。note, email デフォルト値はnoteです。 |
Create, update, delete, and query Highrise Companies. This table is dynamic.
Datetime カラムでは、'>'、および'>=' の演算子だけがサポートされています。
SELECT * FROM Companies WHERE UpdatedAt > '2012-01-12'
新しいCompany の追加には、Company Name およびCompany のBackground の設定が必須です。
INSERT INTO Companies (Name, Background) VALUES ('Company name', 'The description')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id column for the table Companies. | |
| Name | String | False |
The Name column for the table Companies. | |
| Background | String | False |
The Background column for the table Companies. | |
| EmailAddressAggregate | String | False |
The EmailAddressAggregate column for the table Companies. | |
| PhoneNumberAggregate | String | False |
The PhoneNumberAggregate column for the table Companies. | |
| AddressAggregate | String | False |
The AddressAggregate column for the table Companies. | |
| InstantMessengerAggregate | String | False |
The InstantMessengerAggregate column for the table Companies. | |
| TwitterAccountAggregate | String | False |
The TwitterAccountAggregate column for the table Companies. | |
| WebAddressAggregate | String | False |
The WebAddressAggregate column for the table Companies. | |
| AvatarURL | String | False |
The AvatarURL column for the table Companies. | |
| VisibleTo | String | False |
The VisibleTo column for the table Companies. | |
| OwnerId | String | False |
The OwnerId column for the table Companies. | |
| GroupId | String | False |
The GroupId column for the table Companies. | |
| AuthorId | String | True |
The AuthorId column for the table Companies. | |
| CreatedAt | String | True |
The CreatedAt column for the table Companies. | |
| UpdatedAt | String | True |
The UpdatedAt column for the table Companies. | |
| PartyCustomField1 | String | False |
A CustomField of type party. | |
| PartyCustomField2 | String | False |
A CustomField of type party. | |
| SubjectData | String | False |
A Subject Dat for the table Companies. |
Return all custom fields used in the account.
アカウントのCustom Fields を取得します。
SELECT * FROM CustomFields
Custom Fields をタイプ別で取得することもできます。
SELECT * FROM CustomFields WHERE type = 'deal'
新しいCustom Fields の追加には、Label を指定します。'party' タイプのCustom Fields のみが作成できます。
INSERT INTO CustomFields (Label) VALUES ('My new Custom Field')
フィールドのLabel には、Id を指定します。
UPDATE CustomFields SET Label = 'Test' WHERE Id = '4321'
Custom Fields の削除には、Id を指定します。
DELETE FROM CustomFields WHERE Id = '4321'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the custom field. | |
| Label | String | False |
The label for the custom field. | |
| Type | String | True |
The type for the custom field. 使用できる値は次のとおりです。party, deal |
Create, update, delete, and query Deal Categories.
新しいDeal の追加には、Category Name およびColor の設定が必須です。
INSERT INTO DealCategories (Name, Color) VALUES ('A unique deal category', '5df4b5')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier for the category. | |
| Name | String | False |
The name of the category. | |
| Color | String | False |
The color as a hex value. | |
| AccountId | Integer | True |
A reference to the account. | |
| ElementsCount | Integer | True |
The number of elements in the category. | |
| CreatedAt | Datetime | True |
The date and time when this record was created. | |
| UpdatedAt | Datetime | True |
The date and time when this record was last updated. |
Create, update, delete, and query Highrise Deals. This table is dynamic.
Datetime カラムでは、WHERE 句にて'>'、および'>=' の演算子だけがサポートされています。次のクエリは、指定された日の後に更新されたDeal を取得します。
SELECT * FROM Deals WHERE UpdatedAt > '2012-01-12'
新しいDeal の作成には、Name、CategoryId、Background、Currency、Price、PriceType、Duration、およびPartyId が必須です。
INSERT INTO Deals (Name, CategoryId, Background, Currency, Price, PriceType, Duration, PartyId) VALUES ('deal with someone', 4195389, 'black', 'usd', 500, 'fixed', 123545, 149760370)
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id column for the table Deals. | |
| Name | String | False |
The Name column for the table Deals. | |
| AccountId | String | False |
The AccountId column for the table Deals. | |
| AuthorId | String | False |
The AuthorId column for the table Deals. | |
| Background | String | False |
The Background column for the table Deals. | |
| CategoryId | String | False |
The CategoryId column for the table Deals. | |
| Currency | String | False |
The Currency column for the table Deals. | |
| Duration | String | False |
The Duration column for the table Deals. | |
| VisibleTo | String | False |
The VisibleTo column for the table Deals. | |
| GroupId | String | False |
The GroupId column for the table Deals. | |
| OwnerId | String | False |
The OwnerId column for the table Deals. | |
| PartyId | String | False |
The PartyId column for the table Deals. | |
| Price | String | False |
The Price column for the table Deals. | |
| PriceType | String | False |
The PriceType column for the table Deals. | |
| ResponsiblePartyId | String | False |
The ResponsiblePartyId column for the table Deals. | |
| Status | String | False |
The Status column for the table Deals. | |
| StatusChangedOn | String | True |
The StatusChangedOn column for the table Deals. | |
| CreatedAt | String | True |
The CreatedAt column for the table Deals. | |
| UpdatedAt | String | True |
The UpdatedAt column for the table Deals. | |
| DealCustomField1 | String | False |
A Custom Field of type deal. | |
| DealCustomField2 | String | False |
A Custom Field of type deal. |
Query, create, update and delete your account's groups
Highrise アカウントで作成されたグループのリストを取得します。
SELECT * FROM Groups
名前を入れることで新しいグループを作成します。
INSERT INTO Groups (Name) VALUES ('ABC123')
グループId を付けて、グループ名を変更します。
UPDATE Groups SET Name = 'ABC' WHERE Id = '123'
グループId を指定して、グループ名を削除します。
DELETE FROM Groups WHERE Id = '123'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the group. | |
| Name | String | False |
The name of the group. |
Create, update, delete, and query Notes that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal.
Notes の取得には、People、Companies、Cases、もしくはDeals などのNote が所属するSebjectType およびSubject Id を入力します。
SELECT * FROM Notes WHERE SubjectType = 'Companies' AND SubjectId = 149760370特定のnote に関連する情報の取得には note のId を指定します。
SELECT * FROM Notes WHERE Id = 351922361すべての会社からすべてのnote を取得するには、IN 演算子でサブクエリを使用できます。
SELECT * FROM Notes WHERE SubjectType = 'Companies' AND SubjectId IN (SELECT Id FROM Companies)
Datetime カラムでは、WHERE 句にて'>'、および'>=' の演算子だけがサポートされています。
SELECT * FROM Notes WHERE SubjectType = 'Companies' AND SubjectId = 149760370 AND UpdatedAt > '2012-01-12'
新しいNote を作成するには、Note's Body、Subject Id、およびSubject Type が必須です。
INSERT INTO Notes (Body, SubjectId, SubjectType) VALUES ('my note', 149760370, 'Companies')
既存のNote を更新するには、そのId を指定する必要があります。
UPDATE NOTES SET Body = 'updated note' WHERE Id = 499468019
既存のNote を削除するには、そのId を指定する必要があります。
DELETE FROM NOTES WHERE Id = 499929021
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the note. | |
| Title | String | True |
The title of the note. | |
| Body | String | False |
The body of the note. | |
| AuthorId | Integer | True |
The Id of the author of the note. | |
| SubjectId | Integer | True |
The Id of the subject of the note. This can be a reference to a person, company, case, or deal. | |
| SubjectType | String | True |
The subject type of the note: Person, Company, Case, Deal. | |
| SubjectName | String | True |
The subject name of the note. | |
| CollectionId | Integer | True |
The Id of the collection associated with the note. | |
| CollectionType | String | True |
The type of the collection associated with the note. | |
| VisibleTo | String | True |
Who the note is visible to: Everyone, Owner, or NamedGroup. | |
| OwnerId | Integer | True |
The Id of the owner associated with the note. | |
| GroupId | Integer | True |
The Id of the group associated with the note. | |
| CreatedAt | Datetime | True |
The date and time when the note was created. | |
| UpdatedAt | Datetime | True |
The date and time when the note was last updated. | |
| Attachments | String | False |
The attachments attached with the notes. |
Create, update, delete, and query Highrise People. This table is dynamic.
Datetime カラムでは、'>'、および'>=' の演算子だけがサポートされています。
SELECT * FROM People WHERE UpdatedAt > '2016-04-18'
Person を追加するには、First Name、Last Name、およびJob Title が必須です。
INSERT INTO People (FirstName, LastName, Title) VALUES ('FirstName', 'LastName', 'CEO')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id column for the table People. | |
| FirstName | String | False |
The FirstName column for the table People. | |
| LastName | String | False |
The LastName column for the table People. | |
| Title | String | False |
The Title column for the table People. | |
| Background | String | False |
The Background column for the table People. | |
| EmailAddressAggregate | String | False |
The EmailAddressAggregate column for the table People. | |
| PhoneNumberAggregate | String | False |
The PhoneNumberAggregate column for the table People. | |
| AddressAggregate | String | False |
The AddressAggregate column for the table People. | |
| InstantMessengerAggregate | String | False |
The InstantMessengerAggregate column for the table People. | |
| TwitterAccountAggregate | String | False |
The TwitterAccountAggregate column for the table People. | |
| WebAddressAggregate | String | False |
The WebAddressAggregate column for the table People. | |
| CompanyID | String | False |
The CompanyID column for the table People. | |
| CompanyName | String | False |
The CompanyName column for the table People. | |
| LinkedInURL | String | False |
The LinkedInURL column for the table People. | |
| AvatarURL | String | False |
The AvatarURL column for the table People. | |
| VisibleTo | String | False |
The VisibleTo column for the table People. | |
| OwnerId | String | False |
The OwnerId column for the table People. | |
| GroupId | String | False |
The GroupId column for the table People. | |
| AuthorId | String | True |
The AuthorId column for the table People. | |
| CreatedAt | String | True |
The CreatedAt column for the table People. | |
| UpdatedAt | String | True |
The UpdatedAt column for the table People. | |
| PartyCustomField1 | String | False |
A CustomField of type party. | |
| PartyCustomField2 | String | False |
A CustomField of type party. |
Create, update, delete, and query Task Categories.
新しいTask Category の追加には、Category Name およびColor の設定が必須です。
INSERT INTO TaskCategories (Name, Color) VALUES ('A unique task category', '5df4b5')
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
The unique identifier of the task category. | |
| Name | String | False |
The name of the task category. | |
| Color | String | False |
The color as a hex value. | |
| AccountId | Integer | True |
The Id of the account associated with the task category. | |
| ElementsCount | Integer | True |
The number of task categories. | |
| CreatedAt | Datetime | True |
The date and time when the task category was created. | |
| UpdatedAt | Datetime | True |
The date and time when the task category was last updated. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| Account | Retrieve information about the current user's account. |
| Deletions | Query deleted resources. |
| Emails | Query Emails that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal. |
| GroupUsers | Query the groups created in your account and the users that are associated with the groups. |
| Memberships | Query information about your account's memberships. |
| Tags | Query information about your account's tags. |
| Tasks | Retrieve Tasks created in the account. |
| Users | Return information about your account's active users. |
Retrieve information about the current user's account.
カレントユーザーのアカウントに関する情報を取得します。
SELECT * FROM Account
| Name | Type | References | Description |
| Id [KEY] | Integer | The unique identifier of the account in Highrise. | |
| Name | String | The name the account is registered for. | |
| Subdomain | String | The account's subdomain. | |
| Plan | String | The plan the account was opened with. | |
| OwnerId | Integer | The identifier of the account's user. | |
| PeopleCount | Integer | The number of persons maintained in the account. | |
| Storage | Integer | The bytes taken up in the account. | |
| SSLEnabled | Boolean | Whether SSL is enabled for the account. | |
| CreatedAt | Datetime | The date and time when the account was created. | |
| UpdatedAt | Datetime | The date and time when the task category was last updated. | |
| ColorTheme | String | The ColorTheme for the account. |
Query deleted resources.
| Name | Type | References | Description |
| Id [KEY] | Integer | The unique identifier of the deleted resource. | |
| Type | String | The type of resource. | |
| DeletedAt | Datetime | The date and time when the resource was deleted. |
Query Emails that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal.
Email の取得には、People、Company、Case、もしくはDeal などのEmail が所属するSebjectType およびSubject Id を入力します。
SELECT * FROM Emails WHERE SubjectType = 'People' AND SubjectId = '1234567' SELECT * FROM Emails WHERE SubjectType = 'Company' AND SubjectId = '1234567'
特定のEmail に関連する情報の取得には Email のId を指定します。
SELECT * FROM Emails WHERE Id = '1234567'
すべての会社からすべてのE メールを取得するには、IN 演算子でサブクエリを使用できます。
SELECT * FROM Emails WHERE SubjectType = 'Company' AND SubjectId IN (SELECT Id FROM Companies)
Datetime カラムでは、'>'、および'>=' の演算子だけがサポートされています。
SELECT * FROM Emails WHERE SubjectType = 'People' AND SubjectId = '1234567' AND UpdatedAt > "2016-01-01"
| Name | Type | References | Description |
| Id [KEY] | Integer | The unique identifier of the email. | |
| Title | String | The title of the email. | |
| Body | String | The body of the email. | |
| AuthorId | Integer | The Id of the author of the email. | |
| SubjectId | Integer | The Id of the subject of the email. | |
| SubjectType | String | The subject type of the email. The allowed values are People, Company, Case, Deal. | |
| SubjectName | String | The subject name of the email. | |
| CollectionId | Integer | The Id of the collection. | |
| CollectionType | String | The type of the collection. | |
| VisibleTo | String | Who the email is visible to: Everyone, Owner, or NamedGroup. | |
| OwnerId | Integer | The Id of the owner associated with the email. | |
| GroupId | Integer | The Id of the group associated with the email. | |
| CreatedAt | Datetime | The date and time when the email was created. | |
| UpdatedAt | Datetime | The date and time when the email was last updated. | |
| Attachments | String | The attachments attached with the email. |
Query the groups created in your account and the users that are associated with the groups.
アカウントからすべてのグループを取得し、それぞれのグループのすべてのユーザーを取得します。
SELECT * FROM GroupUsers
1つのグループに所属するすべてのユーザーを取得することも可能です。
SELECT * FROM GroupUsers WHERE GroupId = '123'
| Name | Type | References | Description |
| GroupId [KEY] | Integer | The unique identifier of the group. | |
| GroupName | String | The name of the group. | |
| UserId [KEY] | Integer | Id of the user belonging to the group. | |
| Username | String | Name of the user belonging to the group. | |
| UserEmailAddress | String | Name of the user belonging to the group. |
Query information about your account's memberships.
アカウント内のすべてのグループメンバーシップを取得します。
SELECT * FROM Memberships
| Name | Type | References | Description |
| Id [KEY] | Integer | The unique identifier of the membership. | |
| GroupId | Integer | The group identifier of this membership. | |
| UserId | Integer | The user identifier of this membership. | |
| CreatedAt | Datetime | The date and time when the user was added to the group. | |
| UpdatedAt | Datetime | The date and time when the membership was last updated. |
Query information about your account's tags.
アカウント内のすべてのタグを取得します。
SELECT * FROM Tags
| Name | Type | References | Description |
| Id [KEY] | Integer | The unique identifier of the tag. | |
| Name | String | The name of the tag. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SubjectType | String | The subject type of the tag. The allowed values are People, Company, Case, Deal. | |
| SubjectId | Integer | The Id of the subject of the tag. |
Retrieve Tasks created in the account.
カレントユーザーに表示されているすべてのタスクを取得します。
SELECT * FROM Tasks
| Name | Type | References | Description |
| Id [KEY] | Integer | The unique identifier of the task. | |
| AuthorId | Integer | The Id of the user that created the task. | |
| OwnerId | Integer | The Id of the user owning the task. | |
| Body | String | The instructions of the task. | |
| Frame | String | The description for the deadline of the task, such as today,tomorrow,this_week,next_week,later, overdue. | |
| CategoryId | Integer | The category id of the task. | |
| DoneAt | Datetime | The date and time when the task was completed. | |
| DueAt | Datetime | The date and time when the task is due for completion. | |
| AlertAt | Datetime | The date and time when the user will be alerted next about the task. | |
| SubjectId | Integer | The Id of the subject the task is created for. | |
| SubjectName | String | The Name of the subject the task is created for. | |
| SubjectType | String | The subject's type. The types are Case,People,Deal,Company | |
| CreatedAt | Datetime | The date and time when the task category was created. | |
| UpdatedAt | Datetime | The date and time when the task category was last updated. | |
| RecordingId | Integer | The recording Id for the task. |
Return information about your account's active users.
アカウントのすべてのユーザーを取得します。
SELECT * FROM Users
| Name | Type | References | Description |
| Id [KEY] | Integer | The unique identifier of the user. | |
| Name | String | The name of the user. | |
| EmailAddress | String | The email address of the user. | |
| Admin | Boolean | Whether the user has admin privileges | |
| CreatedAt | Datetime | The date and time when the user was created. | |
| UpdatedAt | Datetime | The date and time when the user was last updated. |
ストアドプロシージャはファンクションライクなインターフェースで、Highrise の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにHighrise から関連するレスポンスデータを返します。
| Name | Description |
Gets the OAuth access token from Highrise.
| Name | Type | Required | Description |
| AuthMode | String | True | The Highrise authentication mode. user_agent or web_server. Default is web_server.
デフォルト値はweb_serverです。 |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
| Verifier | String | False | The verifier token returned by Highrise. Required for only the Web AuthMode. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Highrise authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| OAuthAccessToken | String | The OAuth token. |
| OAuthRefreshToken | String | The OAuth refresh token. |
| ExpiresIn | String | The remaining lifetime for the access token in seconds. |
Gets the Highrise authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to Highrise.
| Name | Type | Required | Description |
| CallbackUrl | String | True | The URL that Highrise will return to after the user has authorized your app. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Highrise authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider. |
Refreshes the OAuth access token used for authentication with various Highrise services.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned with the previous access token. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Highrise. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
| プロパティ | 説明 |
| AuthScheme | Whether to connect to Highrise with OAuth2 or APIToken. |
| AccountId | 現在の認証ユーザーのAccount Id。 |
| APIToken | 現在の認証ユーザーのAPI トークン。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | Whether to connect to Highrise with OAuth2 or APIToken. |
| AccountId | 現在の認証ユーザーのAccount Id。 |
| APIToken | 現在の認証ユーザーのAPI トークン。 |
Whether to connect to Highrise with OAuth2 or APIToken.
現在の認証ユーザーのAccount Id。
現在の認証ユーザーのAccount Id。このプロパティは、コマンドの実行に必須です。
現在の認証ユーザーのAPI トークン。
現在の認証ユーザーのAPI トークン。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 がHighrise への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がHighrise への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がHighrise にデータを送信するポート。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 が使用する認証方法を指定します。
サポートされる認証の種類:
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 | 一般情報。接続文字列、製品バージョン(ビルド番号)、および初期接続メッセージが含まれます。 |
|
| EXEC | クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。 |
|
| HTTP | HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス(POST メッセージを含む)、および Kerberos 関連のメッセージが含まれます。 |
|
| WSDL | WSDL/XSD ファイルの生成に関するメッセージ。 | — |
| SSL | SSL 証明書メッセージ。 |
|
| AUTH | 認証関連の失敗/成功メッセージ。 |
|
| SQL | SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。 |
|
| META | メタデータキャッシュとスキーマメッセージ。 |
|
| FUNC | SQL 関数の実行に関連する情報。 |
|
| TCP | TCP トランスポートレイヤーメッセージでの送受信生バイト。 |
|
| FTP | File Transfer Protocol に関するメッセージ。 |
|
| SFTP | Secure File Transfer Protocol に関するメッセージ。 |
|
| POP | Post Office Protocol 経由で転送されるデータに関するメッセージ。 |
|
| SMTP | Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。 |
|
| CORE | 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 | — |
| DEMN | SQL リモーティングに関連するメッセージ。 | — |
| CLJB | 一括データアップロード(クラウドジョブ)に関するメッセージ。 |
|
| SRCE | 他のモジュールに属さない、製品が生成するその他のメッセージ。 | — |
| TRANCE | 低レベルの製品操作に関する高度なメッセージ。 | — |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Highrise 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 プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
| プロパティ | 説明 |
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM People WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。
次に例を示します。
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonUserDefinedViews でビューを指定すると、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.