はじめに

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

SugarCRM への接続

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

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

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

接続の確立

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

SugarCRM への接続

SugarCRM への接続を確立するには、URL をhttp://{sugar crm instance}.com の形式でSugarCRM アカウントに紐付いているURL に設定します。

SugarCRM への認証

Cloud をSugarCRM に認証するには、以下を設定します。

User：SugarCRM アカウントのユーザー。
Password：SugarCRM ユーザーに紐付けられたパスワード。
Platform（オプション）：認証中にログインの競合が発生した場合は、SugarCRM UI で作成したプラットフォームのいずれかに設定。

デフォルトでは、SugarCRM は"sugar" クライアントId を認証に使用しますが、ユーザーはオプションでカスタムアプリのクライアントId とクライアントシークレットの値を指定することができます。詳しくは、カスタムOAuth アプリケーションの作成を参照してください。

OAuthClientId：カスタムOAuth アプリのクライアントId。
OAuthClientSecret：カスタムOAuth アプリのクライアントシークレット。

カスタムOAuth アプリケーションの作成

Creating a Custom OAuth Application

SugarCRM uses the OAuth 2.0 authentication standard. However, unlike the typical OAuth authentication process, SugarCRM uses the "password" grant type to retrieve the access token. This means that it does not open a browser tab during authentication. This makes it easy to connect from both a Desktop Application or a Web Application.

Authenticating with Custom OAuth Consumer Keys

By default, SugarCRM uses the "sugar" client id for authentication, but users can optionally specify the client Id and client secret values of a custom app.

To create a new set of OAuth Consumer Keys:

Log in to SugarCRM with an account that has administrator access.
Navigate to the Admin Dashboard.
On the top right corner of the page, click your profile.
In the dropdown list, select Admin.
In the System section, select OAuth Keys. SugarCRM displays all your default Consumer Keys.
On the main navigation bar (on top of the site), click the OAuth Keys dropdown.
Select Create OAuth Key and fill the required fields:
- OAuth Version = OAuth 2.0
- Consumer Key = your OAuthClientId
- Consumer Secret = your OAuthClientSecret
Click Save. SugarCRM creates your new OAuth Consumer Key.

When you connect the Cloud, it automatically:

extracts the access token from the response and authenticates requests;
refreshes the access token when it expires; and
saves OAuth values in OAuthSettingsLocation to be persisted across connections.

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合して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 Cloud は、SugarCRM のモジュールをリレーショナルテーブルとしてモデル化します。

テーブル定義は動的に取得されます。Cloud は、SugarCRM に接続し、適切なWeb サービスを呼び出してテーブルのリストとテーブルのメタデータを取得します。

Cloud を使用して接続すると、新しいテーブルの追加、新しい列の追加、列のデータ型の変更など、SugarCRM アカウントに対して行う変更は即座に反映されます

Cloud は、テーブルセクションに記載されていないSugarCRM アカウントにもカスタムモジュールを公開できます。これらのカスタムモジュールは、他のテーブルと同じようにクエリを実行できます。さらに、標準モジュールのカスタムフィールドもクエリを実行できます。

以下のセクションでは、SugarCRM 開発環境に含まれるサンプルテーブル定義を示します。

テーブル

Cloud は、Account、Asset、Campaign などのSugarCRM 開発環境サンプルテーブルをリレーショナルテーブルとしてモデル化します。

ビュー

Audit モジュールは、読み取り専用のビューとしてモデル化されています。詳しくは、ビューを参照してください。

ストアドプロシージャ

ストアドプロシージャは、SugarCRM のファンクションライクなインターフェースです。これらはSugarCRM ファイルのダウンロードやカスタムスキーマの作成に使用できます。

テーブル

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

CData Cloud - SugarCRM テーブル


Name	Description
Accounts	The Accounts table.
ACLRoles	The ACLRoles table.
ArchiveRuns	The ArchiveRuns table.
Bugs	The Bugs table.
BusinessCenters	The BusinessCenters table.
Calendar	The Calendar table.
Calls	The Calls table.
CampaignLog	The CampaignLog table.
Campaigns	The Campaigns table.
CampaignTrackers	The CampaignTrackers table.
Cases	The Cases table.
Categories	The Categories table.
ChangeTimers	The ChangeTimers table.
CJ_Forms	The CJ_Forms table.
CJ_WebHooks	The CJ_WebHooks table.
CloudDrivePaths	The CloudDrivePaths table.
CommentLog	The CommentLog table.
Comments	The Comments table.
ConsoleConfiguration	The ConsoleConfiguration table.
Contacts	The Contacts table.
Contracts	The Contracts table.
ContractTypes	The ContractTypes table.
Currencies	The Currencies table.
CustomQueries	The CustomQueries table.
Dashboards	The Dashboards table.
DataArchiver	The DataArchiver table.
DataPrivacy	The DataPrivacy table.
DataSets	The DataSets table.
DocumentMerges	The DocumentMerges table.
DocumentRevisions	The DocumentRevisions table.
Documents	The Documents table.
DocumentTemplates	The DocumentTemplates table.
DocuSignEnvelopes	The DocuSignEnvelopes table.
DRI_SubWorkflows	The DRI_SubWorkflows table.
DRI_SubWorkflow_Templates	The DRI_SubWorkflow_Templates table.
DRI_Workflows	The DRI_Workflows table.
DRI_Workflow_Task_Templates	The DRI_Workflow_Task_Templates table.
DRI_Workflow_Templates	The DRI_Workflow_Templates table.
EAPM	The EAPM table.
EmailAddresses	The EmailAddresses table.
EmailMarketing	The EmailMarketing table.
EmailParticipants	The EmailParticipants table.
Emails	The Emails table.
EmailTemplates	The EmailTemplates table.
EmbeddedFiles	The EmbeddedFiles table.
Employees	The Employees table.
Escalations	The Escalations table.
ExternalUsers	The ExternalUsers table.
Filters	The Filters table.
ForecastManagerWorksheets	The ForecastManagerWorksheets table.
Forecasts	The Forecasts table.
ForecastWorksheets	The ForecastWorksheets table.
Geocode	The Geocode table.
HintAccountsets	The HintAccountsets table.
HintEnrichFieldConfigs	The HintEnrichFieldConfigs table.
HintNewsNotifications	The HintNewsNotifications table.
HintNotificationTargets	The HintNotificationTargets table.
Holidays	The Holidays table.
InboundEmail	The InboundEmail table.
KBArticles	The KBArticles table.
KBContents	The KBContents table.
KBContentTemplates	The KBContentTemplates table.
KBDocuments	The KBDocuments table.
Leads	The Leads table.
Manufacturers	The Manufacturers table.
Meetings	The Meetings table.
Messages	The Messages table.
Metrics	The Metrics table.
MobileDevices	The MobileDevices table.
Notes	The Notes table.
Notifications	The Notifications table.
OAuthKeys	The OAuthKeys table.
OAuthTokens	The OAuthTokens table.
Opportunities	The Opportunities table.
OutboundEmail	The OutboundEmail table.
PdfManager	The PdfManager table.
pmse_Business_Rules	The pmse_Business_Rules table.
pmse_Emails_Templates	The pmse_Emails_Templates table.
pmse_Inbox	The pmse_Inbox table.
pmse_Project	The pmse_Project table.
ProductBundleNotes	The ProductBundleNotes table.
ProductBundles	The ProductBundles table.
ProductCategories	The ProductCategories table.
Products	The Products table.
ProductTemplates	The ProductTemplates table.
ProductTypes	The ProductTypes table.
Project	The Project table.
ProjectTask	The ProjectTask table.
ProspectLists	The ProspectLists table.
PubSub_ModuleEvent_PushSubs	The PubSub_ModuleEvent_PushSubs table.
PurchasedLineItems	The PurchasedLineItems table.
Purchases	The Purchases table.
PushNotifications	The PushNotifications table.
Quotas	The Quotas table.
Quotes	The Quotes table.
Releases	The Releases table.
ReportMaker	The ReportMaker table.
Reports	The Reports table.
ReportSchedules	The ReportSchedules table.
RevenueLineItems	The RevenueLineItems table.
SavedSearch	The SavedSearch table.
Schedulers	The Schedulers table.
ShiftExceptions	The ShiftExceptions table.
Shifts	The Shifts table.
Shippers	The Shippers table.
Styleguide	The Styleguide table.
Subscriptions	The Subscriptions table.
SugarFavorites	The SugarFavorites table.
SugarLive	The SugarLive table.
Tags	The Tags table.
Tasks	The Tasks table.
TaxRates	The TaxRates table.
TeamNotices	The TeamNotices table.
Teams	The Teams table.
TimePeriods	The TimePeriods table.
TrackerPerfs	The TrackerPerfs table.
TrackerQueries	The TrackerQueries table.
Trackers	The Trackers table.
TrackerSessions	The TrackerSessions table.
Users	The Users table.
UserSignatures	The UserSignatures table.
VisualPipeline	The VisualPipeline table.
WebLogicHooks	The WebLogicHooks table.
WorkFlow	The WorkFlow table.


Name	Type	ReadOnly	Description
Id [KEY]	String	False
Deleted	Bool	False
Date_Entered	Datetime	False
Date_Modified	Datetime	False
Modified_User_Id	String	True
Created_By	String	True
Name	String	False
Base_Module	String	False
Status	Bool	False
Description	String	False
Type	String	False
Fire_Order	String	False
Parent_Id	String	False
Record_Type	String	False
List_Order_Y	Int	True

ビュー

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

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

CData Cloud - SugarCRM ビュー


Name	Description
Activities	The Activities view.
Audit	The Audit view.
DropDownValues	The DropDownValues View. This view provides information regarding the values of dropdowns from different fields and modules.
Relationships	The Relationships View. This view provides information regarding different relationships between tables.

Activities

The Activities view.

Columns


Name	Type	Description
Id [KEY]	String	Unique identifier
Name	String
Date_Entered	Datetime	Date record created
Date_Modified	Datetime	Date record last modified
Modified_User_Id	String	User who last modified record
Modified_By_Name	String
Created_By	String	User who created record
Created_By_Name	String
Description	String
Deleted	Bool	Record deletion indicator
Parent_Id	String
Parent_Type	String
Activity_Type	String
Data	String
Comment_Count	Int
Last_Comment	String
Following	Bool	Is user following this record
My_Favorite	Bool	Favorite for the user
Locked_Fields	String
Sync_Key	String

Audit

The Audit view.

Table Specific Information

Select

When querying Audit, you can get Audit logs by specifying the Module name (this is required):

SELECT * FROM Audit WHERE Module = 'Contacts'

Allowed values for Module are: Accounts, KBDocuments, RevenueLineItems, Contacts, Opportunities, Leads

If you want to get Audit logs for a single Module Id, the Audit parent_id needs to be tied to the ID that belongs to the module, for instance:

SELECT * FROM Audit WHERE Module = 'Contacts' AND parent_id = '9d46a91c-43bf-11e8-a83c-0681183120c1'

Columns


Name	Type	Description
Parent_Id	String
Date_Created	Datetime
Created_By	String
Created_By_Username	String
Field_Name	String
Data_Type	String
Before_Value_String	String
After_Value_String	String
Before	String
After	String

Pseudo-Columns

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


Name	Type	Description
Module	String

DropDownValues

The DropDownValues View. This view provides information regarding the values of dropdowns from different fields and modules.

Table Specific Information

Select

When querying DropDownValues, you can create label fields for an existing dropdown list (which is tied to an existing module.) You can get these values simply by specifying the Module name (this is required):

SELECT * FROM DropDownValues WHERE Module = 'Accounts'

If you want to create a custom dropdown list, you can do so, however, the dropdown list needs to be tied to a custom field that belongs to the module, for instance:

SELECT * FROM DropDownValues WHERE Module = 'Accounts' AND Field = 'myCustomDropdown_c

Note that you may need to create a new custom field: Go to the Admin Panel > Studio > Accounts > Fields > Add Field.

Set type as Dropdown and set Drop Down List to the custom dropdown list you've created.

Columns


Name	Type	Description
Module	String	The module containing this dropdown item.
Field	String	The field containing this dropdown item.
ItemName	String	The name of the dropdown item.
DisplayLabel	String	The display label of the dropdown item.

Relationships

The Relationships View. This view provides information regarding different relationships between tables.

Columns


Name	Type	Description
Name	String	The name of the relationship.
DynamicSubpanel	String	The dynamic subpanel of the relationship.
JoinKeyLhs	String	The lhs join key of the relationship.
JoinKeyRhs	String	The rhs join key of the relationship.
JoinTable	String	The name of join table.
LhsKey	String	The lhs key of the relationship.
LhsModule	String	The lhs module of the relationship.
LhsTable	String	The lhs table of the relationship.
RelationshipRoleColumn	String	The name of the relationship role column.
RelationshipRoleColumnValue	String	The value of the relationship role column.
RelationshipType	String	The type of the relationship.
PrimaryFlagColumn	String	The name of the primary flag column.
PrimaryFlagDefault	String	The default value of the primary flag.
PrimaryFlagSide	String	The side of the primary flag.
RhsKey	String	The rhs key of the relationship.
RhsModule	String	The rhs module of the relationship.
RhsTable	String	The rhs table of the relationship.
TrueRelationshipType	String	The true type of the relationship.
UserField	String	The name of the user field.

ストアドプロシージャ

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

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

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


Name	Description

システムテーブル

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

スキーマテーブル

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

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：バッチ処理または単一の更新に関する情報を返す。

sys_catalogs

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

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

SELECT * FROM sys_catalogs

Columns


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

sys_schemas

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

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

          SELECT * FROM sys_schemas

Columns


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

sys_tables

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

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

          SELECT * FROM sys_tables

Columns


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

sys_tablecolumns

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

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

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

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 から返されたフィールドがテーブルの主キーであるかどうか。

sys_procedures

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

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

          SELECT * FROM sys_procedures

Columns


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

sys_procedureparameters

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

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

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

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。

sys_keycolumns

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

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

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

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	主キーのカラム名。

sys_foreignkeys

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

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

         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	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

sys_primarykeys

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

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

         SELECT * FROM sys_primarykeys

Columns


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

sys_indexes

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

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

          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	インデックスのカラムのシーケンスナンバー。

sys_connection_props

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

このテーブルをクエリする際は、config 接続文字列を使用する必要があります。

jdbc:cdata:sugarcrm:config:

この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。

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

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	プロパティに関するその他のさまざまな情報。

sys_sqlinfo

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 構文の詳細。

sys_identity

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

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

         SELECT * FROM sys_identity

Columns


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

接続文字列オプション

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

Authentication

プロパティ	説明
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.

SSL

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

Logging

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

Schema

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

Miscellaneous

プロパティ	説明
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.
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

Authentication

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

プロパティ	説明
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.

You can set it to the value of one of the platforms that you have created in SugarCRM's UI.

To create a new platform in SugarCRM:

Navigate to your Admin Dashboard.
Click your admin icon (located on the top-right of the site).
Click Admin.
In the "Developer Tools" section, click Configure API Platforms.
Add a new platform and click Save.

SSL

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

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

SSLServerCert

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

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

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

Logging

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

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

Verbosity

ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

データ型

string

デフォルト値

"1"

解説

Verbosity レベルは、Cloud がLogfile にどの程度の詳細さで記載するかを決定します。1 から5 までのVerbosity レベルがサポートされています。より詳しい説明は、ログページに記載されています。

Schema

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

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

BrowsableSchemas

解説

The available aggregate column modes are detailed below:


Ignore	All aggregate will be ignored and will not show up as available columns in the table definition.
List	Aggregate columns will be listed in all tables, but on base tables such as Contacts, they will not retrieve data from SugarCRM.
ListAndRetrieve	Aggregate columns will be listed and requested on all tables. Note that when this mode is activated, primitive columns that are also part of the aggregates will be returned as NULL. For example, in the Accounts table, the Team_Id column, which is also part of the Team_Name aggregate, will be returned as NULL.

LinkColumnsMode

解説

The default language used is 'English US'.

Available languages are: Albanian, Arabic, Bulgarian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, English UK, English US, Estonian, Finnish, French, German, Greek, Hebrew, Hungarian, Italian, Japanese, Korean, Latvian, Lithuanian, Norwegian, Polish, Portuguese, Portuguese Brazilian, Romanian, Russian, Serbian, Slovak, Spanish, Spanish Latin America, Swedish, Thai, Traditional Chinese, Turkish, Ukrainian.

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.

データ型

bool

デフォルト値

false

解説

Relationships are the basis for linking information within the SugarCRM system. The relationships are exposed by the Cloud in the form of views. Set this to true if you want to expose relationship Views.

For example:

SELECT * FROM REL_account_tasks = '514b69aa-41e0-11ea-a5ef-02424563122e'
SELECT * FROM Accounts WHERE accounts_contacts = 'e9b69b60-41e0-11ea-82f2-02424563122e'
SELECT * FROM Notes WHERE accounts_notes_1 = '514b69aa-41e0-11ea-a5ef-02424563122e'
SELECT * FROM Accounts WHERE accounts_notes_1 IN ('4a6cd5de-f40e-11ea-99f0-02f85148f4a4', '456ffdc2-f40e-11ea-86ca-02f85148f4a4')

IncludeFiltersAsViews

Set this to true if you want to expose filters for the modules as views.

データ型

bool

デフォルト値

true

解説

You can query the filtered modules like you would query the views:

SELECT * FROM [Filter_Cases_Open Cases]

where "Cases" is the name of the module and "Open Cases" is the name of the filter applied to that module.

Use the connection property ModulesFiltersList to control the list of filters that the Cloud exposes (as a View) for each module.

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.

データ型

string

デフォルト値

"Accounts, Leads, Opportunities, Sales Order, Quotes, Calendar, Reports, Emails, Calls, Meetings, Tasks, Notes, NDA, Tracking Numbers, Cases"

解説

These views have the following naming convention: Filter_{{module_name}}_{{filtername}}. For example: [Filter_Cases_Open Cases]

By default, we expose the modules listed on the Top menu bar in SugarCRM UI.

If you need more/fewer modules, you can specify them in a comma-separated list.

Set the value to * to expose the Filters for all modules.

**Note: The names on the list must be the original English names of the modules.

For the full list of filters in your system, please query the 'Filters' table.

IncludeReports

Set this to true if you want to expose reports as views.

データ型

bool

デフォルト値

false

解説

You can query the reports like you would query the views:

SELECT * FROM [Report_Revenues per industry (2021)]

where "Revenues per industry (2021)" is the name of the report.

If you experience performance issues, use the connection properties Pagesize and RowScanDepth to control how the driver queries the report metadata.

ReportModulesList

The nested values of non-primitive objects will be pushed as JSON aggregates.

To access the values of those aggregates you can use the JSON_EXTRACT function.

IncludeDeleted

Specify whether to get deleted records.

データ型

bool

デフォルト値

false

解説

Set this to true in order to retrieve deleted records in the result set.

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.

データ型

bool

デフォルト値

true

解説

解説

テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。

大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。

Timeout

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

データ型

int

デフォルト値

60

解説

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

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

Cloud

SugarCRM - CData Cloud

概要

主要機能

はじめに

SugarCRM への接続

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

接続の確立

SugarCRM への接続

SugarCRM への認証

カスタムOAuth アプリケーションの作成

Creating a Custom OAuth Application

Authenticating with Custom OAuth Consumer Keys

SSL の設定

SSL 設定のカスタマイズ

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

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

テーブル

ビュー

ストアドプロシージャ

テーブル

CData Cloud - SugarCRM テーブル

Accounts

Columns

ACLRoles

Columns

ArchiveRuns

Columns

Bugs

Columns

BusinessCenters

Columns

Calendar

Columns

Calls

Columns

CampaignLog

Columns

Campaigns

Columns

CampaignTrackers

Columns

Cases

Columns

Categories

Columns

ChangeTimers

Columns

CJ_Forms

Columns

CJ_WebHooks

Columns

CloudDrivePaths

Columns

CommentLog

Columns

Comments

Columns

ConsoleConfiguration

Columns

Contacts

Columns

Contracts

Columns

ContractTypes

Columns

Currencies

Columns

CustomQueries

Columns

Dashboards

Columns

DataArchiver

Columns

DataPrivacy

Columns

DataSets