接続の確立

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

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Highrise への認証

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

OAuth

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

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

Web アプリケーション

Web アプリケーション経由で接続する場合は、Highrise にカスタムOAuth アプリケーションを登録する必要があります。それからSync App を使用してOAuth トークンの値を取得および管理します。詳しくは、カスタムOAuth アプリの作成を参照してください。

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

OAuthClientId：アプリケーション設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL をアプリケーション設定で指定したリダイレクトURI に設定します。必要に応じて、"Permissions" パラメータを設定してカスタム権限をリクエストします。
ストアドプロシージャがOAuth エンドポイントのURL を返します。
ステップ1でストアドプロシージャが返したURL に移動します。ログインしてWeb アプリケーションを認可します。コールバックURL にリダイレクトされます。
GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、リダイレクトURL のクエリ文字列のcode パラメータに設定します。

OAuthAccessToken 接続プロパティをストアドプロシージャで返されたアクセストークンに設定し、データに接続します。ExpiresIn 秒後に、アクセストークンの期限が切れたときは、GetOAuthAccessToken を再度呼び出し、新しいアクセストークンを取得します。

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 はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

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

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

プロキシベースのファイヤーウォールを使用するには、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 テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

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

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]	Integer	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	Integer	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	Datetime	True		The CreatedAt column for the table Companies.
UpdatedAt	Datetime	True		The UpdatedAt column for the table Companies.
PartyCustomField1	String	False		A CustomField of type party.
PartyCustomField2	String	False		A CustomField of type party.

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, and PartyId) VALUES('deal with someone', 4195389, 'black', 'usd', 500, 'fixed', 123545, 149760370)

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False		The Id column for the table Deals.
Name	String	False		The Name column for the table Deals.
AccountId	Integer	False		The AccountId column for the table Deals.
AuthorId	Integer	False		The AuthorId column for the table Deals.
Background	String	False		The Background column for the table Deals.
CategoryId	Integer	False		The CategoryId column for the table Deals.
Currency	String	False		The Currency column for the table Deals.
Duration	Integer	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	Integer	False		The OwnerId column for the table Deals.
PartyId	Integer	False		The PartyId column for the table Deals.
Price	Long	False		The Price column for the table Deals.
PriceType	String	False		The PriceType column for the table Deals.
ResponsiblePartyId	Integer	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	Datetime	True		The CreatedAt column for the table Deals.
UpdatedAt	Datetime	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.

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, or 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.

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]	Integer	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	Integer	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	Integer	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	Datetime	True		The CreatedAt column for the table People.
UpdatedAt	Datetime	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.

ビュー

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Highrise Connector for CData Sync ビュー


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

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.

接続文字列オプション

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

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

Authentication

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

OAuth

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

SSL

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

Firewall

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
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	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

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。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

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	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はHighrise への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

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

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Proxy

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

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

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

ProxyServer

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

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

BASIC： Sync App はHTTP BASIC 認証を行います。
DIGEST： Sync App はHTTP DIGEST 認証を行います。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

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

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

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

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

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

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。


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

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

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

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Logging

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

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログページを参照してください。

Schema

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

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

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

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、パフォーマンスが向上します。

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Miscellaneous

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

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

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

統合およびフォーマット


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

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

各ルートエレメントはビューの名前を定義します。
各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"