このページでは、CData Cloud でのHighrise への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Highrise への接続

接続の確立 は、CData Cloud にデータベースを作成するためのHighrise への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してHighrise からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Highrise に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

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。

カスタムOAuth アプリケーションを作成するタイミング

CData はOAuth アプリケーション認証情報を製品に組み込んでおり、から接続する際に使用できます。

以下の場合はユーザー自身のOAuth アプリケーションクレデンシャルを選択できます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

カスタムアプリの作成

https://integrate.37signals.com にログインしてアプリケーションを登録し、OAuth クライアントクレデンシャルであるOAuthClientId、およびOAuthClientSecret を取得する必要があります。CallbackURL の設定も必要です。

デスクトップアプリケーションでHighrise へ認証

次の接続プロパティを設定して、接続してください。

• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
• CallbackURL：アプリケーション設定で指定したリダイレクトURL に設定。
• AccountId：これは、Highrise へのログイン後にURL からコピーしてください。例えば、インスタンスURL がhttps://MyInstance12345.highrisehq.com/ の場合は、AccountId プロパティを' MyInstance12345 ' に設定します。

接続すると、Cloud はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。Cloud がOAuth プロセスを完了します。

1. コールバックURL からアクセストークンを取得し、リクエストを認証します。
2. アクセストークンの期限が切れたときにはリフレッシュしてください。
3. OAuth 値をOAuthSettingsLocation に保存します。これらの値は接続間で永続化されます。

Web アプリケーションからHighrise へ認証

次の接続プロパティを設定し、アクセストークンを取得します。

• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
• CallbackURL：これをWeb アプリケーション上のユーザーの認証後にリダイレクトするページに設定してください。

Web アプリケーションから接続する場合、またはCloud にブラウザウィンドウを開く権限がない場合は、verifier code とOAuthAccessToken を交換する必要があります。

1. GetOAuthAuthorizationURL を呼び出します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
2. ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
3. verifier code をCallbackURL の"code" クエリ文字列パラメータから取得して、GetOAuthAccessToken を呼び出します。

Highrise にリクエストを投げるには、OAuthAccessToken およびAccountId を設定します。アクセストークンの期限が切れたときは、RefreshOAuthAccessToken を呼び出します。リフレッシュトークンを入力すると、有効なOAuth アクセストークンが返されます。

SSL 設定のカスタマイズ

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

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

CData Cloud は、Highrise API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。 Cloud は、Highrise API を使用してサポートされているフィルタを処理します。その他のフィルタは、Cloud 内でクライアント側で処理されます。

テーブル

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

ビュー

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

ストアドプロシージャ

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

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

CData Cloud - Highrise テーブル

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.

テーブル固有の情報

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.

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です。

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.

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

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.

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.

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.

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.

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.

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.

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

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

CData Cloud - Highrise ビュー

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

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

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.

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.

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.

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.

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.

Query information about your account's tags.

テーブル固有の情報

Select

アカウント内のすべてのタグを取得します。

SELECT * FROM Tags

Columns

Name	Type	References	Description
Id [KEY]	Integer		The unique identifier of the tag.
Name	String		The name of the tag.

Pseudo-Columns

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

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

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.

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.

ストアドプロシージャはファンクションライクなインターフェースで、Highrise の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

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

CData Cloud - Highrise ストアドプロシージャ

Name	Description

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Highrise のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	データベース名。

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、People テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='People' 

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType	String	スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

ストアドプロシージャパラメータについて説明します。

次のクエリは、RefreshOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName	String	データ型の名前。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。
Values	String	このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams	Boolean	パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath	Boolean	パラメータがスキーマ作成操作のターゲットパスかどうか。
Default	String	何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName	String	複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided	Boolean	プロシージャがネイティブのHighrise プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

主キーおよび外部キーについて説明します。

次のクエリは、People テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='People' 
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	サポートされている文字列関数。	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	サポートされている数値関数。	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	サポートされている日付および時刻関数。	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	製品名。
Version	String	製品のバージョン番号。
Datasource	String	製品が接続するデータソースの名前。
NodeId	String	製品がインストールされているマシンの固有識別子。
HelpURL	String	製品のヘルプドキュメントのURL。
License	String	製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
Location	String	製品のライブラリが格納されているファイルパスの場所。
Environment	String	製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersion	String	本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategory	String	CData Sync 機能のカテゴリ（例：Source、Destination）。

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

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 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

SSL

---

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

Logging

---

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema

---

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

Miscellaneous

---

プロパティ	説明
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	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.

Possible Values

OAuth2, APIToken

データ型

string

デフォルト値

"OAuth2"

解説

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

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

データ型

string

デフォルト値

""

解説

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

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

データ型

string

デフォルト値

""

解説

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

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

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります：

• カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
• ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

データ型

string

デフォルト値

""

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

• この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
• クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

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

---

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

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

データ型

string

デフォルト値

""

解説

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

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

---

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

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

---

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

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

データ型

string

デフォルト値

""

解説

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

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

---

プロパティ	説明
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

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

データ型

int

デフォルト値

-1

解説

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

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

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

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

データ型

string

デフォルト値

""

解説

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

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

Table1=Column1;Table1=Column2;Table2=Column3

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

*=*

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

データ型

int

デフォルト値

60

解説

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

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

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

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

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.