接続プロパティ
接続プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続設定で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、はじめにを参照してください。
プロパティ | 説明 |
User | 認証で使用されるSugarCRM ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
APIVersion | The version of the SugarCRM used. |
URL | The URL of the SugarCRM account in the form 'http://{sugar crm instance}.com'. |
Platform | The SugarCRM platform that you want to use during your session. |
プロパティ | 説明 |
InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
OAuthVerifier | OAuth 認可URL から返された検証コード。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | この接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。 |
ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
ProxyPort | プロキシサーバー( ProxyServer 接続プロパティで指定)が起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。 |
ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
ProxyPassword | ProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
Logfile | ログファイルの名前と場所を指定するファイルパス。 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
LogModules | ログファイルに含めるコアモジュール。 |
MaxLogFileSize | ログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。 |
MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
CacheProvider | データのキャッシュに使用されるプロバイダーの名前。 |
CacheDriver | データのキャッシュに使用されるデータベースドライバー。 |
CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
プロパティ | 説明 |
Pagesize | The maximum number of results to return per page from SugarCRM. |
AggregateColumnMode | Controls how aggregate columns are treated by the provider. |
LinkColumnsMode | Controls how the 'link' type columns are exposed by the provider provider. |
UseDisplayNames | Set this to true to use the table and column names from the UI. By default, the provider displays the API names for tables and columns. |
DisplayLanguage | The language used with the provider. This affects table names, view names and column names. |
IncludeRelationships | Set this to true if you want to expose relationship columns, which give you the ability to query objects in relation to other objects. |
IncludeFiltersAsViews | Set this to true if you want to expose filters for the modules as views. |
ModulesFiltersList | Each SugarCRM module has named filters. This property enables you to control the list of filters that the provider exposes (as a view) for each module. |
IncludeReports | Set this to true if you want to expose reports as views. |
ReportModulesList | In SugarCRM, each report is built upon a specific module. This connection property enables you to control the list of reports the provider exposes as Views. |
FlattenReportObjects | Specifies whether or not to flatten the objects' data for report views. |
FlattenReportsArrayDepth | Specifies the maximum depth of array elements to flatten for report views. |
IncludeDeleted | Specify whether to get deleted records. |
ServerSideOrderBy | Set this to true if you want to perform the order by operation server-side. Keep in mind that having or creating indexes results in the best query performance. |
BatchSize | 送信する各バッチ処理の最大サイズ。 |
DefaultDomain | このプロパティは、Oracle Database Gateway for ODBC で使用されます。 |
EnableForeignKeyDetection | ODBC で外部キーを検出するかどうか。 |
IncludeDualTable | Oracle データベースとの互換性を向上するためにOracle DUAL テーブルのモックを作成するには、このプロパティを設定します。 |
LimitKeySize | 主キーカラムの最大長。 |
MapBigintToVarchar | このプロパティは、bigint 型がSQL_BIGINT の代わりにSQL_VARCHAR にマップされるかどうかをコントロールします。デフォルトはfalse です。 |
MapToInt | このプロパティは、Long 型がSQL_BIGINT の代わりにSQL_INTEGER にマップされるかどうかをコントロールします。デフォルトはfalse です。 |
MapToLongVarchar | このプロパティは、カラムをSQL_LONGVARCHAR として返すかどうかを制御します。 |
MapToWVarchar | このプロパティは、文字列型をSQL_VARCHAR ではなくSQL_WVARCHAR にマッピングするかどうかを制御します。デフォルトではSQL_WVARCHAR が設定されます。 |
MaximumColumnSize | カラムの最大サイズ。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
Readonly | このプロパティを使用して、provider からSugarCRM へのアクセスを読み取り専用に設定できます。 |
RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
RTK | ライセンス供与で使用されるランタイムキー。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UpperCaseIdentifiers | このプロパティは、大文字で設定されているすべての識別子を報告します。これは、Oracle データベースのデフォルト設定で、Oracle Database Gateway のようなOracle ツールとの統合を向上します。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |