接続の確立

Highrise への接続を追加

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

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

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

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

Highrise への認証

Highrise はOAuth およびAPI トークン認証スキームをサポートします。

OAuth

Highrise はOAuth 認証標準を利用しています。Highrise へ認証するには、OAuthClientId、OAuthClientSecret、およびCallbackURL を取得する必要があります。

すべてのOAuth フローで、AuthScheme をOAuth に設定する必要があります。以下のセクションは、すでに設定済みであることを前提として書かれています。

API トークン

API トークンでHighrise へ認証するには、以下を設定します。

AuthScheme：AuthScheme をAPIToken に設定。
APIToken：ユーザーのAPIToken。 API トークンを取得するには、Highrise アカウントにログインしてMy Info のリンクをクリックします。管理者またはユーザーの場合、アカウントの"Settings" セクションにあります。詳しくは、Highrise ドキュメントのFind Your API Token を参照してください。
AccountId：ユーザーのAccount Id。

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

SSL の設定

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 に設定します。

データモデル

CData Sync App は、Highrise API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

テーブル

CData Sync App は、書き込み可能なHighrise API をアクセスしやすいテーブルにモデル化します。ほとんどのテーブルは、シンプルなテキストベースのスキーマファイルにより定義されています。ただし、Companies、Deals、およびPeople などのテーブルは動的にスキーマ定義されます。接続時にSync App は、適切なWeb サービスを呼び出して動的にテーブルのメタデータを取得します。

ビュー

ビューは読み取り専用のテーブルです。通常は、変更ができないデータはビューとして表されます。

ストアドプロシージャ

Sync App は、ストアドプロシージャを利用可能にし、Highrise のファンクションライクなインターフェースにより、API の追加の機能を利用可能にします。

テーブル

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

Highrise Connector for CData Sync テーブル


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.

Cases

Create, update, delete, and query Cases that are visible to the authenticated user.

テーブル固有の情報

Insert

新しいCase を挿入するには、Name が必要です。

INSERT INTO Cases (Name) VALUES ('my case')

Columns


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.

Comments

Create, update, delete, and query Comments associated with a Note or Email and visible to the authenticated user.

テーブル固有の情報

Select

Comments の取得には、Notes およびEmails などのNote が所属するSebjectType およびSubject Id を入力します。

SELECT * FROM Comments WHERE SubjectType = 'notes' AND SubjectId = '351922361'

Insert

Comment の挿入には、次のクエリを入力します。Common Body およびParentId は必須です。

INSERT INTO Comments (Body, ParentId) VALUES ('me comment', '351199012')

Columns


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.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name

Type

Description

ParentType

String

Whether the comment is associated with a note or email.

使用できる値は次のとおりです。note, email

デフォルト値はnoteです。

Companies

Create, update, delete, and query Highrise Companies. This table is dynamic.

テーブル固有の情報

Select

Datetime カラムでは、'>'、および'>=' の演算子だけがサポートされています。

SELECT * FROM Companies WHERE UpdatedAt > '2012-01-12'

Insert

新しいCompany の追加には、Company Name およびCompany のBackground の設定が必須です。

INSERT INTO Companies (Name, Background) VALUES ('Company name', 'The description')

Columns


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.

CustomFields

Return all custom fields used in the account.

テーブル固有の情報

Select

アカウントのCustom Fields を取得します。

SELECT * FROM CustomFields

Custom Fields をタイプ別で取得することもできます。

SELECT * FROM CustomFields WHERE type = 'deal'

Insert

新しいCustom Fields の追加には、Label を指定します。'party' タイプのCustom Fields のみが作成できます。

INSERT INTO CustomFields (Label) VALUES ('My new Custom Field')

Update

フィールドのLabel には、Id を指定します。

UPDATE CustomFields SET Label = 'Test' WHERE Id = '4321'

Delete

Custom Fields の削除には、Id を指定します。

DELETE FROM CustomFields WHERE Id = '4321'

Columns


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

DealCategories

Create, update, delete, and query Deal Categories.

テーブル固有の情報

Insert

新しいDeal の追加には、Category Name およびColor の設定が必須です。

INSERT INTO DealCategories (Name, Color) VALUES ('A unique deal category', '5df4b5')

Columns


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.

Deals

Create, update, delete, and query Highrise Deals. This table is dynamic.

テーブル固有の情報

Select

Datetime カラムでは、WHERE 句にて'>'、および'>=' の演算子だけがサポートされています。次のクエリは、指定された日の後に更新されたDeal を取得します。

SELECT * FROM Deals WHERE UpdatedAt > '2012-01-12'

Insert

新しい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)

Columns


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.

Groups

Query, create, update and delete your account's groups

テーブル固有の情報

Select

Highrise アカウントで作成されたグループのリストを取得します。

SELECT * FROM Groups

Insert

名前を入れることで新しいグループを作成します。

INSERT INTO Groups (Name) VALUES ('ABC123')

Update

グループId を付けて、グループ名を変更します。

UPDATE Groups SET Name = 'ABC' WHERE Id = '123'

Delete

グループId を指定して、グループ名を削除します。

DELETE FROM Groups WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The unique identifier of the group.
Name	String	False		The name of the group.

Notes

Create, update, delete, and query Notes that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal.

テーブル固有の情報

Select

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'

Insert

新しいNote を作成するには、Note's Body、Subject Id、およびSubject Type が必須です。

INSERT INTO Notes (Body, SubjectId, SubjectType) VALUES ('my note', 149760370, 'Companies')

Update

既存のNote を更新するには、そのId を指定する必要があります。

UPDATE NOTES SET Body = 'updated note' WHERE Id = 499468019

Delete

既存のNote を削除するには、そのId を指定する必要があります。

DELETE FROM NOTES WHERE Id = 499929021

Columns


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.

People

Create, update, delete, and query Highrise People. This table is dynamic.

テーブル固有の情報

Select

Datetime カラムでは、'>'、および'>=' の演算子だけがサポートされています。

SELECT * FROM People WHERE UpdatedAt > '2016-04-18'

Insert

Person を追加するには、First Name、Last Name、およびJob Title が必須です。

INSERT INTO People (FirstName, LastName, Title) VALUES ('FirstName', 'LastName', 'CEO')

Columns


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.

TaskCategories

Create, update, delete, and query Task Categories.

テーブル固有の情報

Insert

新しいTask Category の追加には、Category Name およびColor の設定が必須です。

INSERT INTO TaskCategories (Name, Color) VALUES ('A unique task category', '5df4b5')

Columns


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.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Highrise Connector for CData Sync ビュー


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.

Account

Retrieve information about the current user's account.

テーブル固有の情報

Select

カレントユーザーのアカウントに関する情報を取得します。

SELECT * FROM Account

Columns


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.

Deletions

Query deleted resources.

Columns


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.

Emails

Query Emails that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal.

テーブル固有の情報

Select

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"

Columns


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.

GroupUsers

Query the groups created in your account and the users that are associated with the groups.

テーブル固有の情報

Select

アカウントからすべてのグループを取得し、それぞれのグループのすべてのユーザーを取得します。

SELECT * FROM GroupUsers

1つのグループに所属するすべてのユーザーを取得することも可能です。

SELECT * FROM GroupUsers WHERE GroupId = '123'

Columns


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.

Memberships

Query information about your account's memberships.

テーブル固有の情報

Select

アカウント内のすべてのグループメンバーシップを取得します。

SELECT * FROM Memberships

Columns


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.

Tasks

Retrieve Tasks created in the account.

テーブル固有の情報

Select

カレントユーザーに表示されているすべてのタスクを取得します。

SELECT * FROM Tasks

Columns


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.

Users

Return information about your account's active users.

テーブル固有の情報

Select

アカウントのすべてのユーザーを取得します。

SELECT * FROM Users

Columns


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.

接続文字列オプション

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

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

Authentication

プロパティ	説明
AuthScheme	Whether to connect to Highrise with OAuth2 or APIToken.
AccountId	現在の認証ユーザーのAccount Id。
APIToken	現在の認証ユーザーのAPI トークン。

OAuth

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

SSL

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

Firewall

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

Proxy

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）の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

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Authentication

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

プロパティ	説明
AuthScheme	Whether to connect to Highrise with OAuth2 or APIToken.
AccountId	現在の認証ユーザーのAccount Id。
APIToken	現在の認証ユーザーのAPI トークン。

AuthScheme

Whether to connect to Highrise with OAuth2 or APIToken.

解説

OAuth2: Set this to perform OAuth2 authentication.
APIToken: Set this to perform APIToken authentication.

AccountId

現在の認証ユーザーのAccount Id。

解説

現在の認証ユーザーのAccount Id。このプロパティは、コマンドの実行に必須です。

APIToken

現在の認証ユーザーのAPI トークン。

解説

現在の認証ユーザーのAPI トークン。

OAuth

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

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

SSL

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

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

SSLServerCert

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

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

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

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

FirewallType

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 を使ってください。

FirewallServer

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

解説

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

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

FirewallPort

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

解説

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

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

FirewallUser

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

解説

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

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

FirewallPassword

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

解説

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

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

Proxy

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

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

ProxyAutoDetect

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

解説

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

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

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

ProxyServer

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

解説

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

ProxyPort

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

解説

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

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

ProxyAuthScheme

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

解説

認証タイプは次のいずれかです。

BASIC：Sync App はHTTP BASIC 認証を行います。
DIGEST：Sync App はHTTP DIGEST 認証を行います。
NTLM：Sync App はNTLM トークンを取得します。
NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
NONE：ProxyServer が認証を必要としない場合に設定します。

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

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

ProxyUser

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 接続プロパティは設定しないでください。

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

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

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

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


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

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

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

ProxySSLType

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

解説

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


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

ProxyExceptions

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

解説

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

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

Logging

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

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

LogModules

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

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログの「高度なログの記録」セクションを参照してください。

Schema

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

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

Location

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

解説

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

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


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

BrowsableSchemas

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

解説

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

Tables

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

解説

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

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

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

Views

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

解説

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

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

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

Miscellaneous

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

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

MaxRows

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

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

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

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。複数のプロパティをセミコロン区切りのリストで定義できます。

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

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


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

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

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

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UserDefinedViews

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

解説

このプロパティを使用すると、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.json。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

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

Highrise Connector for CData Sync

Highrise Connector for CData Sync

概要

Highrise バージョンサポート

接続の確立

Highrise への接続を追加

Highrise への認証

OAuth

API トークン

高度な機能

ユーザー定義ビュー

SSL の設定

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

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

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

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

テーブル

ビュー

ストアドプロシージャ

テーブル

Highrise Connector for CData Sync テーブル

Cases

テーブル固有の情報

Insert

Columns

Comments

テーブル固有の情報

Select

Insert

Columns

Pseudo-Columns

Companies

テーブル固有の情報

Select

Insert

Columns

CustomFields

テーブル固有の情報

Select

Insert

Update

Delete

Columns

DealCategories

テーブル固有の情報

Insert

Columns

Deals

テーブル固有の情報

Select

Insert

Columns

Groups

テーブル固有の情報

Select

Insert

Update

Delete

Columns

Notes

テーブル固有の情報

Select

Insert

Update

Delete

Columns

People

テーブル固有の情報

Select

Insert

Columns

TaskCategories

テーブル固有の情報

Insert