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

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

Sansan への接続

CData Sync App を使用してSansan に接続する場合は、APIKey が必要です。

Sansan へのアクセスの設定

APIKey を取得するには、以下の手順に従ってください。

• Sansan 管理画面 [https://ap.sansan.com/v/home/] にログインして、［外部サービス連携］メニューの［API］に移動します。
• ［部署を選択してください］のプルダウンから、対象の部署を選択します。
• ［ユーザーを選択してください］のプルダウンから、対象のユーザーを選択します。
• ［発行］ボタンをクリックして、API キーを生成します。

Sansan アカウントの認証

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

• APIKey：API キーを設定。Sansan 管理画面から取得したAPI Key です。

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

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 は、Sansan オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 Sansan オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。 次のセクションでは、利用可能なAPI オブジェクトを示し、Sansan API へのSQL の実行について詳しく説明します。

ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。

Sync App は、Sansan API にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをインメモリで処理します。 Sync App がクライアントサイドのインメモリ処理でAPI 制限を回避する方法の詳細については、SupportEnhancedSQL を参照してください。

Sync App はSansan のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。

一般的には、Sansan テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

Sansan Connector for CData Sync テーブル

Name	Description
Bizcards	Create and query all the Bizcards that the user has scanned or those that the organization has

Create and query all the Bizcards that the user has scanned or those that the organization has

テーブル固有の情報

Select

Sync App は Sansan API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でドライバー内部で処理されます。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Bizcards

SELECT * FROM Bizcards WHERE UpdatedTime>'2018-03-14'

SELECT * FROM Bizcards WHERE UpdatedTime='2018-03-14 18:35:06.0'

SELECT * FROM Bizcards WHERE UpdatedTime>'2018-03-14' AND UpdatedTime<'2019-03-14'

SELECT * FROM Bizcards WHERE Email='[email protected]'

SELECT * FROM Bizcards ORDER BY UpdatedTime Desc

SELECT * FROM Bizcards ORDER BY RegisteredTime

SELECT * FROM Bizcards WHERE CONTAINS(CompanyName, 'kei') AND CONTAINS(Tel, '7390') AND CONTAINS(Mobile, '7415')

SELECT * FROM Bizcards WHERE SearchTerm = 'kei'

クエリ内で指定することでRange 接続プロパティをオーバーライドできます。例：

SELECT * FROM Bizcards WHERE Range='me'

Insert

INSERT INTO Bizcards ('OwnerId', 'FirstName', 'LastName', 'SharingPermissionsEmail') VALUES ('afd425d', 'John', 'Doe', true)

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Columns

Name	Type	ReadOnly	Description
BizcardId [KEY]	String	True	The Id of the Bizcard
CompanyId	String	True	The Id of the Company
PersonId	String	True	The Id of the person
ExchangeDate	Date	False	The date when Bizcards were exchanged
RegisteredTime	Datetime	True	The datetime when the Bizcard was registered
UpdatedTime	Datetime	True	The datetime when the Bizcard was last updated
OwnerId	String	False	The Id of the owner
OwnerName	String	True	The name of the owner
OwnerEmail	String	True	The email of the owner
LastName	String	False	The last name found on Bizcard
FirstName	String	False	The first name found on Bizcard
LastNameReading	String	False
FirstNameReading	String	False
DepartmentName	String	False	The name of the department found on Bizcard
Title	String	False	The title found on Bizcard
Email	String	False	The email found on Bizcard
Mobile	String	False	The mobile number found on Bizcard
CompanyName	String	False	The company name found on Bizcard
CountryCode	String	False	The country code found on Bizcard
PostalCode	String	False	The postal code found on Bizcard
Address	String	True	The address found on Bizcard
Prefecture	String	False	The prefecture found on Bizcard
City	String	False	The city found on Bizcard
Street	String	False	The street found on Bizcard
Building	String	False	The building found on Bizcard
Tel	String	False	The telephone number found on Bizcard
SecondTel	String	False	The second telephone number found on Bizcard
Fax	String	False	The fax number found on Bizcard
Url	String	False	The url found on Bizcard
Memo	String	False	The memo found on Bizcard
EntryStatus	String	True	The status of the Bizcard {processing, completed, unreadable}
IsUserCreated	Boolean	True	Determines if the bizcard has been created by the user or not
HasUnrecognizedChar	Boolean	True	Determines if the bizcard has unrecognized char or not
TagId	String	False	The tag ID to be linked to the business card. This column is supported for Insert only.
SharingPermissionsCompanyInformation	Boolean	False	Company information public/private setting. This column is supported for Insert only.
SharingPermissionsName	Boolean	False	Name public/private setting. This column is supported for Insert only.
SharingPermissionsExchangeDate	Boolean	False	Exchange date public/private setting. This column is supported for Insert only.
SharingPermissionsContact	Boolean	False	Contact public/private setting. This column is supported for Insert only.
SharingPermissionsMobile	Boolean	False	Mobile public/private setting. This column is supported for Insert only.
SharingPermissionsEmail	Boolean	False	Email public/private setting. This column is supported for Insert only.
SharingPermissionsMemo	Boolean	False	Memo public/private setting. This column is supported for Insert only.
SharingPermissionsOthers	Boolean	False	Others public/private setting. This column is supported for Insert only.

Pseudo-Columns

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

Name	Type	Description
Range	String	Used to override the range connection property
SearchTerm	String	Search FirstName or LastName starting by criteria

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

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

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

Sansan Connector for CData Sync ビュー

Name	Description
AcquireDepartment	This will acquire departments registered in Sansan
AcquireUser	This will acquire users registered in Sansan
BizcardTags	Join Table for Tags and Bizcards
Contacts	Get a Set of contacts. The contacts are ordered by update time.
ExternalAttendees	Usage information for the operation ExternalAttendees.rsd.
InternalAttendees	Usage information for the operation InternalAttendees.rsd.
Tags	Returns all tags created by user or organization tags

This will acquire departments registered in Sansan

Columns

Name	Type	Description
TempId	String	This is the temporary identifier used when adding departments
DepartmentId	String	This is the department identifier
DepartmentName	String	This is the departments name
DepartmentNamePhonetic	String	If the departments name is not written alphabetically, you can enter the phonetic alphabetic reading of the name here
ParentDepartmentId	String	This is the identifier for a parent department
Order	Integer	This is the display order of the department
DeleteFlag	Integer	This is the flag used to delete departments

Pseudo-Columns

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

Name	Type	Description
Delimiter	String	Separator in the CSV format response

This will acquire users registered in Sansan

Columns

Name	Type	Description
TempId	String	This is the temporary identifier used when adding users
UserUuid	String	This is the identifier to uniquely identify a user in Sansan
DepartmentId	String	This is the identifier for the department that the user belongs to
UserId	String	This is the identifier for display that uniquely identifies a user in Sansan
UserName	String	This is the users name
AlternativeName	String	This can use be used for alternative names or foreign language names
Email	String	This is the users email address
SubEmail	String	This is the users sub-email address
EffectiveDateFrom	String	This is the date when Sansan usage started
Culture	Integer	This is the display language when using Sansan
MailFormat	Integer	This is the format for receiving emails
SamlNameId	String	This is the identifier for SAML authentication
UserType	Integer	This is the user type
CanUpdateData	Integer	This is the permission to update all data
DataDownloadPrivilege	Integer	This is the permission to download business cards and reports
EmailDeliveryPrivilege	Integer	This is the permission to use email delivery
SalesforceIntegrationPrivilege	Integer	This is the permission to link business card data with Salesforce
DealPrivilege	Integer	This is the permission to use Deal management
ApiIntegrationPrivilege	Integer	This is the permission to use API linking
UsageStatisticsPrivilege	Integer	This is the permission to check actual usage of Sansan
OrganizationTreeDownloadPrivilege	Integer	Input 1 to give this permission
DeleteFlag	Integer	This is the flag used to delete users

Pseudo-Columns

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

Name	Type	Description
Delimiter	String	Separator in the CSV format response

Join Table for Tags and Bizcards

テーブル固有の情報

Select

Sync App は Sansan API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でドライバー内部で処理されます。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM BizcardTags

クエリ内で指定することでRange 接続プロパティをオーバーライドできます。例：

SELECT * FROM BizcardTags WHERE Range='me'

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Columns

Name	Type	Description
BizcardId [KEY]	String	The Id of the Bizcard
TagID [KEY]	String	The Id of the Tag

Pseudo-Columns

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

Name	Type	Description
Range	String	Used to override the range connection property

Get a Set of contacts. The contacts are ordered by update time.

テーブル固有の情報

Select

Sync App は Sansan API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でドライバー内部で処理されます。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Contacts

SELECT * FROM Contacts WHERE UpdatedTime>'2018-03-14'

SELECT * FROM Contacts WHERE UpdatedTime='2018-03-14 18:35:06.0'

SELECT * FROM Contacts WHERE UpdatedTime>'2018-03-14' AND UpdatedTime<'2019-03-14'

SELECT * FROM Contacts WHERE Type='Meeting'

SELECT * FROM Contacts WHERE Categories='category'

SELECT * FROM Contacts ORDER BY UpdatedTime Desc

SELECT * FROM Contacts ORDER BY RegisteredTime

クエリ内で指定することでRange 接続プロパティをオーバーライドできます。例：

SELECT * FROM Contacts WHERE Range='me'

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Columns

Name	Type	Description
Id [KEY]	String	The identifier of teh contact.
RegisteredTime	Datetime	The datetime when the contact has been created.
UpdatedTime	Datetime	The datetime when the contact has been modified for the last time.
StartDate	Date
StartTime	Datetime
EndDate	Date
EndTime	Datetime
OwnerId	String	The identifier of the owner.
OwnerName	String	The name of the owner.
OwnerEmail	String	The email of the owner.
Type	String	The type of the contact.
Categories	String	The contact categories.
Title	String	The title of the contact.
Location	String	The location of the contact.
Memo	String	The memo of the contact.
ExternalAttendees	String	The external attendees associated with the contact.
InternalAttendees	String	The internal attendees associated with the contact.

Pseudo-Columns

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

Name	Type	Description
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

Usage information for the operation ExternalAttendees.rsd.

テーブル固有の情報

Select

すべてはドライバー内でクライアント側で実行されます。

Columns

Name	Type	Description
ContactId [KEY]	String	The identifier of the contact associated with the attendee.
Id [KEY]	String	The identifier of the attendee.
PersonId	String	The person identifier associated with the attendee.
CompanyName	String	The company where the attendee belongs to.
LastName	String	The last name of the attendee.
FirstName	String	The first name of the attendee.

Pseudo-Columns

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

Name	Type	Description
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

Usage information for the operation InternalAttendees.rsd.

テーブル固有の情報

Select

すべてはドライバー内でクライアント側で実行されます。

Columns

Name	Type	Description
ContactId [KEY]	String	The identifier of the contact associated with the attendee.
Id [KEY]	String	The identifier of the attendee.
Name	String	The name of the attendee.
DepartmentName	String	The department where the attendee belongs to.

Pseudo-Columns

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

Name	Type	Description
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

Returns all tags created by user or organization tags

テーブル固有の情報

Select

Sync App は Sansan API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でドライバー内部で処理されます。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Tags

クエリ内で指定することでRange 接続プロパティをオーバーライドできます。例：

SELECT * FROM Tags WHERE Range='me'

クエリ内でBizcardId を指定することで、名刺のすべてのタグを取得することもできます。例：

SELECT * FROM Tags WHERE BizcardId='00E683BEE2DFC04399B3CC8DA5591A24'

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Columns

Name	Type	Description
TagID [KEY]	String	The Id of the Tag
Name	String	The name of the Tag
Type	String	The type of the Tag {public, shared, private}
OwnerID	String	The Id of the owner
OwnerName	String	The name of teh owner
OwnerEmail	String	The email of the owner

Pseudo-Columns

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

Name	Type	Description
Range	String	Used to override the range connection property
BizcardId	String	Used to get the tags of a Bizcard specified by BizcardId

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

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

Authentication

---

プロパティ	説明
APIKey	Sansan API キー。
IncludePastBizcards	IncludePastBizcards
Range	対象とする所有者の範囲。

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	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Sansan から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

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

---

プロパティ	説明
APIKey	Sansan API キー。
IncludePastBizcards	IncludePastBizcards
Range	対象とする所有者の範囲。

Sansan API キー。

解説

認証に使用されます。APIKey はアカウントの［設定］ページから取得できます。

IncludePastBizcards

解説

過去の名刺情報も含めて取得するかどうかを決定します。

対象とする所有者の範囲。

解説

Range 接続プロパティは、API からフェッチされるデータのスコープを決定します。 Range が"all" に設定されている場合、プロバイダーはユーザーが所属する組織のすべての名刺またはタグをフェッチします。 Range が"me" の場合は、自身の所有する名刺またはタグをフェッチします。 クエリ中にこの接続プロパティをオーバーライドできます。例：

SELECT * FROM Bizcards WHERE Range='all'

SELECT * FROM Tags WHERE Range='me'

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

---

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

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

解説

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

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

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

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

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

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

---

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

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

解説

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

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はSansan への接続を開き、プロキシを経由して通信が行われます。
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 を使ってください。

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

解説

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

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

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

解説

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

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

解説

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

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

解説

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

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

---

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

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

解説

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

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

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

解説

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

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

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

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

解説

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

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 を参照してください。

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

解説

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

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

user@domain
domain\user

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

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	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

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

解説

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

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

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

---

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

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

解説

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

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

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

---

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

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

解説

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

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

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

解説

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

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

解説

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

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

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

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

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

解説

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

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

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

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

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

---

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

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

解説

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

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

解説

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

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

統合およびフォーマット

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

Sansan から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Sansan から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

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

解説

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

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

解説

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

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

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

解説

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

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

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

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

次に例を示します。

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

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

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