CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるSugarCRM へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してSugarCRM に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、SugarCRM への接続を標準化し、構成することができます。
このページでは、CData Cloud でのSugarCRM への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのSugarCRM への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してSugarCRM からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、SugarCRM に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
SugarCRM への接続を確立するには、URL をhttp://{sugar crm instance}.com の形式でSugarCRM アカウントに紐付いているURL に設定します。
Cloud をSugarCRM に認証するには、以下を設定します。
デフォルトでは、SugarCRM は"sugar" クライアントId を認証に使用しますが、ユーザーはオプションでカスタムアプリのクライアントId とクライアントシークレットの値を指定することができます。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。
To create a new set of OAuth Consumer Keys:
When you connect the Cloud, it automatically:
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Cloud は、SugarCRM のモジュールをリレーショナルテーブルとしてモデル化します。
テーブル定義は動的に取得されます。Cloud は、SugarCRM に接続し、適切なWeb サービスを呼び出してテーブルのリストとテーブルのメタデータを取得します。
Cloud を使用して接続すると、新しいテーブルの追加、新しい列の追加、列のデータ型の変更など、SugarCRM アカウントに対して行う変更は即座に反映されます
Cloud は、テーブル セクションに記載されていないSugarCRM アカウントにもカスタムモジュールを公開できます。これらのカスタムモジュールは、他のテーブルと同じようにクエリを実行できます。さらに、標準モジュールのカスタムフィールドもクエリを実行できます。
以下のセクションでは、SugarCRM 開発環境に含まれるサンプルテーブル定義を示します。
Cloud は、Account、Asset、Campaign などのSugarCRM 開発環境サンプルテーブルをリレーショナルテーブル としてモデル化します。
Audit モジュールは、読み取り専用のビューとしてモデル化されています。詳しくは、ビュー を参照してください。
ストアドプロシージャ は、SugarCRM のファンクションライクなインターフェースです。これらはSugarCRM ファイルのダウンロードやカスタムスキーマの作成に使用できます。
Cloud はSugarCRM のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| 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. |
Cloud は、テーブル に記載されていないSugarCRM アカウントにもカスタムモジュールを公開できます。普通のテーブルと同様に、このカスタムモジュールに対してクエリを実行できます。さらに、標準モジュールのカスタムフィールドをクエリすることができます。
The Accounts table.
| Name | Type | ReadOnly | Description |
| Account_Type | String | False |
The Company is of this type |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Affiliated_Business_Or_Jv_C | Bool | False | |
| Affiliationothername_C | String | False | |
| Agentstarthistorydate_C | Date | False | |
| Agenttrax_User_C | Bool | False | |
| Agenttrax_User_Notes_C | String | False | |
| Agenttraxaccounttype_C | String | False | |
| Agenttraxaccttype_C | String | False | |
| Annual_Revenue | String | False |
Annual revenue for this company |
| Area_C | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | Decimal | False | |
| Billing_Address_City | String | False |
The city used for billing address |
| Billing_Address_Country | String | False |
The country used for the billing address |
| Billing_Address_Postalcode | String | False |
The postal code used for billing address |
| Billing_Address_State | String | False |
The state used for billing address |
| Billing_Address_Street | String | False |
The street address used for billing address |
| Business_Center_Id | String | False |
The business center to which the case is associated |
| Business_Center_Name | String | True |
The name of the business center represented by the business_center_id field |
| Campaign_Id | String | False |
Campaign that generated Account |
| Campaign_Name | String | True |
The first campaign name for Account (Meta-data only) |
| Cancellation_Date_C | Date | False | |
| Claimsratioytdloc_C | Decimal | False | |
| Commentlog | String | True | |
| Commission_C | Decimal | False | |
| Contact_To_Discuss_Audits_C | String | False | |
| Contact_To_Discuss_Claims_C | String | False | |
| Contact_To_Discuss_General_C | String | False | |
| Contact_To_Discuss_Premiums_C | String | False | |
| Contact_To_Discuss_Reporting_C | String | False | |
| Cplspriorytdloc_C | Int | False | |
| Cplsytdloc_C | Int | False | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Credit_Reports_Agent_Permiss_C | Bool | False | |
| Credit_Reports_Last_Run_Off_C | Date | False | |
| Currency_Id | String | False | |
| Currytdnetloc_C | Decimal | False | |
| Cyber_Insurance_Coverage_C | Bool | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Dba_C | String | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Doctype_C | String | False | |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | True | |
| Duns_Num | String | False |
DUNS number of the account |
| Ec_Purchasing_User_C | Bool | False | |
| String | False | ||
| Email_Addresses_Non_Primary | String | False | |
| Email_Opt_Out | Bool | False | |
| Email1 | String | False | |
| Email2 | String | False | |
| Employees | String | False |
Number of employees, varchar to accomodate for both number (100) or range (50-100) |
| Epay_User_C | Bool | False | |
| Est_Total_Prem_Gen_At_Office_C | Decimal | False | |
| Estatement_User_C | Bool | False | |
| Estimated_Fntg_Wallet_Share_C | String | False | |
| String | False |
The facebook name of the company | |
| Fidelity_Pak_User_C | Bool | False | |
| Fnf_Agencies_Accounts_1_Name | String | True | |
| Fnf_Agencies_Accounts_1fnf_Agencies_Ida | String | False | |
| Following | Bool | False |
Is user following this record |
| Googleplus | String | False |
The Google Plus name of the company |
| Hint_Account_Facebook_Handle | String | False |
company facebook |
| Hint_Account_Fiscal_Year_End | String | False |
FY End |
| Hint_Account_Founded_Year | String | False |
company founded year |
| Hint_Account_Industry | String | False |
Company Industry |
| Hint_Account_Industry_Tags | String | False |
industry tags |
| Hint_Account_Location | String | False |
Company Location |
| Hint_Account_Logo | String | False |
company logo |
| Hint_Account_Naics_Code_Lbl | String | False |
NAICS Code |
| Hint_Account_Pic | String | False |
Hint Account logo |
| Hint_Account_Size | String | False |
Company Size |
| Id [KEY] | String | True |
Unique identifier |
| Industry | String | False |
The company belongs in this industry |
| Invalid_Email | Bool | False | |
| Is_Escalated | Bool | True |
Is this escalated? |
| Jacketsorderedytdloc_C | String | False | |
| Jv_Or_Afba_Partner_Name_C | String | False | |
| Lastaccountingperiod_C | String | False | |
| Lastupdatedate_C | Datetime | False | |
| Local_Tag_C | String | False | |
| Locked_Fields | String | True | |
| Maxliability_C | Decimal | False | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| Mtcc_Modules_In_Use_C | String | False | |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Name of the Company |
| Name_City_State_C | String | False | |
| Nasid_C | String | False | |
| Next_Renewal_Date | Date | True | |
| Ownership | String | False | |
| Parent_Id | String | False |
Account ID of the parent of this account |
| Parent_Name | String | True | |
| Perform_Sugar_Action | Bool | False | |
| Phone_Alternate | String | False |
An alternate phone number |
| Phone_Fax | String | False |
The fax phone number of this company |
| Phone_Office | String | False |
The office phone number |
| Primarylocation_C | Bool | False | |
| Prior_Year_Total_Premium_C | Decimal | False | |
| Prioreoynetloc_C | Decimal | False | |
| Priorytdnetloc_C | Decimal | False | |
| Prospect_Numb_Sales_Calls_C | Int | False | |
| Prospecting_Next_Step_C | String | False | |
| Prospecting_Notes_C | String | False | |
| Rating | String | False |
An arbitrary rating for this company for use in comparisons with others |
| Reportedpoliciesytdloc_C | Int | False | |
| Rynoh_Erecon_C | Bool | False | |
| Service_Level | String | False |
An indication of the service level of a company |
| Shipping_Address_City | String | False |
The city used for the shipping address |
| Shipping_Address_Country | String | False |
The country used for the shipping address |
| Shipping_Address_Postalcode | String | False |
The zip code used for the shipping address |
| Shipping_Address_State | String | False |
The state used for the shipping address |
| Shipping_Address_Street | String | False |
The street address used for for shipping purposes |
| Sic_Code | String | False |
SIC code of the account |
| Software_Escrow_Title_C | String | False | |
| Status_C | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Test_Contact_For_Claims_C | String | False | |
| Ticker_Symbol | String | False |
The stock trading (ticker) symbol for the company |
| Titlepoint_User_C | Bool | False | |
| Titlepoint_User_Notes_C | String | False | |
| Titlewave_User_C | Bool | False | |
| String | False |
The twitter name of the company | |
| Website | String | False |
URL of website for the company |
| Widget_Next_Renewal_Date | String | True | |
| Ytdvarianceloc_C | Decimal | False |
The ACLRoles table.
| Name | Type | ReadOnly | Description |
| Access_Override | Int | True | |
| Created_By | String | True |
User who created record |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
The role description |
| Id [KEY] | String | True |
Unique identifier |
| Modified_User_Id | String | True |
User who last modified record |
| Name | String | False |
The role name |
The ArchiveRuns table.
| Name | Type | ReadOnly | Description |
| Archiver_Id | String | False |
ID associated with the Data Archiver |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Of_Archive | Datetime | False |
The date and time this archiver was run |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Filter_Def | String | False |
The filter definition associated with the run |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Ids_Processed | String | False |
The IDs that were processed in this run |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Num_Processed | Int | False |
The number of fields archived/deleted |
| Process_Type | String | False |
Whether the data was deleted or archived |
| Source_Module | String | False |
The source module |
| Sync_Key | String | True | |
| Tag | String | False |
The Bugs table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Bug_Number | Int | False |
Visual unique identifier |
| Business_Hours_To_Resolution | Decimal | True |
How long it took to resolve this issue, in decimal business hours |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Fixed_In_Release | String | False |
The software or service release that corrected the bug |
| Fixed_In_Release_Name | String | True | |
| Follow_Up_Datetime | Datetime | False |
Deadline for following up on an issue |
| Following | Bool | False |
Is user following this record |
| Found_In_Release | String | False |
The software or service release that manifested the bug |
| Hours_To_Resolution | Decimal | True |
How long it took to resolve this issue, in decimal calendar hours |
| Id [KEY] | String | True |
Unique identifier |
| Is_Escalated | Bool | True |
Is this escalated? |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
The short description of the bug |
| Pending_Processing | Bool | True | |
| Portal_Viewable | Bool | False | |
| Priority | String | False |
An indication of the priorty of the issue |
| Product_Category | String | False |
Where the bug was discovered (ex: Accounts, Contacts, Leads) |
| Release_Name | String | True | |
| Resolution | String | False |
An indication of how the issue was resolved |
| Resolved_Datetime | Datetime | False |
Date when an issue is resolved |
| Source | String | False |
An indicator of how the bug was entered (ex: via web, email, etc.) |
| Source_Id | String | False | |
| Source_Meta | String | False | |
| Source_Type | String | False | |
| Status | String | False |
The status of the issue |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Type | String | False |
The type of issue (ex: issue, feature) |
| Widget_Follow_Up_Datetime | String | True | |
| Work_Log | String | False |
Free-form text used to denote activities of interest |
The BusinessCenters table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Address_City | String | False |
City of this Business Center |
| Address_Country | String | False |
Country of this Business Center |
| Address_Postalcode | String | False |
Postal Code of this Business Center |
| Address_State | String | False |
State of this Business Center |
| Address_Street | String | False |
Address of this Business Center |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Friday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Friday |
| Friday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Friday |
| Friday_Open_Hour | String | False |
The hour portion of the time this business center is open on Friday |
| Friday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Friday |
| Id [KEY] | String | True |
Unique identifier |
| Is_Open_Friday | Bool | False |
Explicit marker for if this business center is open on Friday |
| Is_Open_Monday | Bool | False |
Explicit marker for if this business center is open on Monday |
| Is_Open_Saturday | Bool | False |
Explicit marker for if this business center is open on Saturday |
| Is_Open_Sunday | Bool | False |
Explicit marker for if this business center is open on Sunday |
| Is_Open_Thursday | Bool | False |
Explicit marker for if this business center is open on Thursday |
| Is_Open_Tuesday | Bool | False |
Explicit marker for if this business center is open on Tuesday |
| Is_Open_Wednesday | Bool | False |
Explicit marker for if this business center is open on Wednesday |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| Monday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Monday |
| Monday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Monday |
| Monday_Open_Hour | String | False |
The hour portion of the time this business center is open on Monday |
| Monday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Monday |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Saturday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Saturday |
| Saturday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Saturday |
| Saturday_Open_Hour | String | False |
The hour portion of the time this business center is open on Saturday |
| Saturday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Saturday |
| Sunday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Sunday |
| Sunday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Sunday |
| Sunday_Open_Hour | String | False |
The hour portion of the time this business center is open on Sunday |
| Sunday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Sunday |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Thursday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Thursday |
| Thursday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Thursday |
| Thursday_Open_Hour | String | False |
The hour portion of the time this business center is open on Thursday |
| Thursday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Thursday |
| Timezone | String | False |
Time Zone in which this Business Center operates |
| Tuesday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Tuesday |
| Tuesday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Tuesday |
| Tuesday_Open_Hour | String | False |
The hour portion of the time this business center is open on Tuesday |
| Tuesday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Tuesday |
| Wednesday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Wednesday |
| Wednesday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Wednesday |
| Wednesday_Open_Hour | String | False |
The hour portion of the time this business center is open on Wednesday |
| Wednesday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Wednesday |
The Calendar table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Agenda_Event_Template | String | True | |
| Allow_Create | Bool | False | |
| Allow_Delete | Bool | False | |
| Allow_Update | Bool | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Calendar_Filter | String | True | |
| Calendar_Module | String | False | |
| Calendar_Type | String | True | |
| Color | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Day_Event_Template | String | True | |
| Dblclick_Event | String | True | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Duration_Days | String | True | |
| Duration_Hours | String | True | |
| Duration_Minutes | String | True | |
| Event_End | String | True | |
| Event_Start | String | False | |
| Event_Tooltip_Template | String | True | |
| Following | Bool | False |
Is user following this record |
| Ical_Event_Template | String | True | |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| Month_Event_Template | String | True | |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Schedulermonth_Event_Template | String | True | |
| Subject | String | True | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Timeline_Event_Template | String | True | |
| Week_Event_Template | String | True |
The Calls table.
| Name | Type | ReadOnly | Description |
| Accept_Status | String | False | |
| Accept_Status_Users | String | False | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Auto_Invite_Parent | Bool | False |
Flag to allow for turning off auto invite of parent record - (Meta-data only) |
| Aws_Contact_Id | String | True |
The AWS Connect Contact ID |
| Aws_Lens_Data | String | False |
Raw data from the aws lens service |
| Call_Differentiating_Value_C | String | False | |
| Call_Recording | String | True |
The friendly name for the call recording link |
| Call_Recording_Url | String | False |
The URL for the call recording |
| Cj_Activity_Tpl_Name | String | True | |
| Cj_Actual_Sort_Order | String | False | |
| Cj_Allow_Activity_By | String | False | |
| Cj_Blocked_By_Stages | String | False | |
| Cj_Momentum_End_Date | Datetime | False | |
| Cj_Momentum_Points | Int | True | |
| Cj_Momentum_Ratio | Double | True | |
| Cj_Momentum_Score | Int | True | |
| Cj_Momentum_Start_Date | Datetime | False | |
| Cj_Parent_Activity_Id | String | False | |
| Cj_Parent_Activity_Type | String | False | |
| Cj_Url | String | False | |
| Commentlog | String | True | |
| Contact_Id | String | True | |
| Contact_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Customer_Journey_Blocked_By | String | False | |
| Customer_Journey_Points | String | False | |
| Customer_Journey_Progress | Double | True | |
| Customer_Journey_Score | Int | True | |
| Date_End | Datetime | True |
Date is which call is scheduled to (or did) end |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Start | Datetime | False |
Date in which call is schedule to (or did) start |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Direction | String | False |
Indicates whether call is inbound or outbound |
| Dri_Subworkflow_Id | String | False | |
| Dri_Subworkflow_Name | String | True | |
| Dri_Subworkflow_Template_Id | String | False | |
| Dri_Subworkflow_Template_Name | String | True | |
| Dri_Workflow_Id | String | False | |
| Dri_Workflow_Name | String | True | |
| Dri_Workflow_Sort_Order | String | False | |
| Dri_Workflow_Task_Template_Id | String | False | |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | True | |
| Duration_Hours | Int | False |
Call duration, hours portion |
| Duration_Minutes | String | False |
Call duration, minutes portion |
| Email_Reminder_Checked | Bool | False |
checkbox indicating whether or not the email reminder value is set (Meta-data only) |
| Email_Reminder_Sent | Bool | False |
Whether email reminder is already sent |
| Email_Reminder_Time | String | False |
Specifies when a email reminder alert should be issued; -1 means no alert; otherwise the number of seconds prior to the start |
| Fnf_Agencies_Calls_1_Name | String | True | |
| Fnf_Agencies_Calls_1fnf_Agencies_Ida | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Internal_Notes | String | False |
Internal notes for the call |
| Invitees | String | True | |
| Is_Cj_Parent_Activity | Bool | False | |
| Is_Customer_Journey_Activity | Bool | False | |
| Lead_Id | String | True | |
| Lead_Name | String | True | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Brief description of the call |
| Outlook_Id | String | False |
When the Sugar Plug-in for Microsoft Outlook syncs an Outlook appointment, this is the Outlook appointment item ID |
| Parent_Id | String | False |
The ID of the parent Sugar object identified by parent_type |
| Parent_Name | String | True | |
| Parent_Type | String | True |
The Sugar object to which the call is related |
| Recurrence_Id | Datetime | False |
Recurrence ID of call. Original call start date |
| Recurring_Source | String | False |
Source of recurring call |
| Reminder_Checked | Bool | False |
checkbox indicating whether or not the reminder value is set (Meta-data only) |
| Reminder_Time | String | False |
Specifies when a reminder alert should be issued; -1 means no alert; otherwise the number of seconds prior to the start |
| Repeat_Count | Int | True |
Number of recurrence |
| Repeat_Days | String | False |
Days of month |
| Repeat_Dow | String | False |
Days of week in recurrence |
| Repeat_Interval | Int | True |
Interval of recurrence |
| Repeat_Ordinal | String | False |
Repeat ordinal value |
| Repeat_Parent_Id | String | False |
Id of the first element of recurring records |
| Repeat_Selector | String | False |
Repeat selector |
| Repeat_Type | String | False |
Type of recurrence |
| Repeat_Unit | String | False |
Repeat unit value |
| Repeat_Until | Date | False |
Repeat until specified date |
| Send_Invites | Bool | False |
checkbox indicating whether or not to send out invites (Meta-data only) |
| Sentiment_Score_Agent | Decimal | True |
The sentiment score for the agent ranging from -5 to 5 |
| Sentiment_Score_Agent_First_Quarter | Decimal | True |
The sentiment score for the agent during the first quarter ranging from -5 to 5 |
| Sentiment_Score_Agent_Fourth_Quarter | Decimal | True |
The sentiment score for the agent during the fourth quarter ranging from -5 to 5 |
| Sentiment_Score_Agent_Second_Quarter | Decimal | True |
The sentiment score for the agent during the second quarter ranging from -5 to 5 |
| Sentiment_Score_Agent_String | String | True | |
| Sentiment_Score_Agent_Third_Quarter | Decimal | True |
The sentiment score for the agent during the third quarter ranging from -5 to 5 |
| Sentiment_Score_Customer | Decimal | True |
The sentiment score for the customer ranging from -5 to 5 |
| Sentiment_Score_Customer_First_Quarter | Decimal | True |
The sentiment score for the customer during the first quarter ranging from -5 to 5 |
| Sentiment_Score_Customer_Fourth_Quarter | Decimal | True |
The sentiment score for the customer during the fourth quarter ranging from -5 to 5 |
| Sentiment_Score_Customer_Second_Quarter | Decimal | True |
The sentiment score for the customer during the second quarter ranging from -5 to 5 |
| Sentiment_Score_Customer_String | String | True | |
| Sentiment_Score_Customer_Third_Quarter | Decimal | True |
The sentiment score for the customer during the third quarter ranging from -5 to 5 |
| Set_Accept_Links | String | False | |
| Start_Next_Journey_Id | String | False | |
| Status | String | False |
The status of the call (Held, Not Held, etc.) |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Transcript | String | True | |
| Type_Of_Call_C | String | False |
The CampaignLog table.
| Name | Type | ReadOnly | Description |
| Activity_Date | Datetime | False |
The date the activity occurred |
| Activity_Type | String | False |
The activity that occurred (e.g., Viewed Message, Bounced, Opted out) |
| Archived | Bool | False |
Indicates if item has been archived |
| Campaign_Content | String | False | |
| Campaign_Id | String | False |
Campaign identifier |
| Campaign_Name | String | False | |
| Campaign_Name1 | String | True | |
| Campaign_Objective | String | False | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False |
Record deletion indicator |
| Hits | Int | True |
Number of times the item has been invoked (e.g., multiple click-thrus) |
| Id [KEY] | String | True |
Unique identifier |
| List_Id | String | False |
The target list from which item originated |
| Marketing_Id | String | False |
ID of marketing email this entry is associated with |
| Marketing_Name | String | False | |
| More_Information | String | False | |
| Recipient_Email | String | False | |
| Recipient_Name | String | True | |
| Related_Id | String | False | |
| Related_Name | String | True | |
| Related_Type | String | False | |
| Target_Id | String | False |
Identifier of target record |
| Target_Tracker_Key | String | False |
Identifier of Tracker URL |
| Target_Type | String | False |
Descriptor of the target record type (e.g., Contact, Lead) |
The Campaigns table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Actual_Cost | Decimal | True |
Actual cost of the campaign |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Budget | Decimal | True |
Budgeted amount for the campaign |
| Campaign_Type | String | False |
The type of campaign |
| Commentlog | String | True | |
| Content | String | False |
The campaign description |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | True |
inhertied but not used |
| End_Date | Date | False |
Ending date of the campaign |
| Expected_Cost | Decimal | True |
Expected cost of the campaign |
| Expected_Revenue | Decimal | True |
Expected revenue stemming from the campaign |
| Following | Bool | False |
Is user following this record |
| Frequency | String | False |
Frequency of the campaign |
| Id [KEY] | String | True |
Unique identifier |
| Impressions | Int | True |
Expected Click throughs manually entered by Campaign Manager |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
The name of the campaign |
| Objective | String | False |
The objective of the campaign |
| Start_Date | Date | False |
Starting date of the campaign |
| Status | String | False |
Status of the campaign |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Tracker_Count | Int | True |
The number of accesses made to the tracker URL; no longer used as of 4.2 (see campaign_trkrs) |
| Tracker_Key | Int | False |
The internal ID of the tracker used in a campaign; no longer used as of 4.2 (see campaign_trkrs) |
| Tracker_Text | String | False |
The text that appears in the tracker URL; no longer used as of 4.2 (see campaign_trkrs) |
The CampaignTrackers table.
| Name | Type | ReadOnly | Description |
| Campaign_Id | String | False |
The ID of the campaign |
| Created_By | String | True |
User ID who created record |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Id [KEY] | String | True |
Unique identifier |
| Is_Optout | Bool | False |
Indicator whether tracker URL represents an opt-out link |
| Modified_User_Id | String | True |
User who last modified record |
| Tracker_Key | Int | False |
Internal key to uniquely identifier the tracker URL |
| Tracker_Name | String | False |
The name of the campaign tracker |
| Tracker_Url | String | False |
The URL that represents the landing page when the tracker URL in the campaign email is clicked |
The Cases table.
| Name | Type | ReadOnly | Description |
| Account_Id | String | False |
The account to which the case is associated |
| Account_Name | String | False |
The name of the account represented by the account_id field |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Action_Claim | String | True | |
| Action_Close | String | True | |
| Action_Unassign | String | True | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Attachment_List | String | True | |
| Business_Center_Id | String | False |
The business center to which the case is associated |
| Business_Center_Name | String | True |
The name of the business center represented by the business_center_id field |
| Business_Hours_To_Resolution | Decimal | True |
How long it took to resolve this issue, in decimal business hours |
| Business_Hrs_To_First_Response | Decimal | True | |
| Case_Number | Int | False |
Visual unique identifier |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | True | |
| First_Response_Actual_Datetime | Datetime | True | |
| First_Response_Sent | Bool | False | |
| First_Response_Sla_Met | String | False | |
| First_Response_Target_Datetime | Datetime | True | |
| First_Response_User_Id | String | False | |
| First_Response_User_Name | String | True | |
| First_Response_Var_From_Target | Decimal | True | |
| Follow_Up_Datetime | Datetime | False |
Deadline for following up on an issue |
| Following | Bool | False |
Is user following this record |
| Hours_To_First_Response | Decimal | True | |
| Hours_To_Resolution | Decimal | True |
How long it took to resolve this issue, in decimal calendar hours |
| Id [KEY] | String | True |
Unique identifier |
| Is_Escalated | Bool | True |
Is this escalated? |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
The short description of the bug |
| Pending_Processing | Bool | True | |
| Perform_Sugar_Action | Bool | False | |
| Portal_Viewable | Bool | False | |
| Primary_Contact_Id | String | False | |
| Primary_Contact_Name | String | True | |
| Priority | String | False |
The priority of the case |
| Request_Close | Bool | True |
The request close status of the case |
| Request_Close_Date | Datetime | True |
The date/time that the request close was initiated |
| Resolution | String | False |
The resolution of the case |
| Resolved_Datetime | Datetime | False |
Date when an issue is resolved |
| Service_Level | String | True |
Service level of the associated account of case |
| Source | String | False |
An indicator of how the case was entered (ex: via web, email, etc.) |
| Source_Id | String | False | |
| Source_Meta | String | False | |
| Source_Type | String | False | |
| Status | String | False |
The status of the case |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Type | String | False |
The type of issue (ex: issue, feature) |
| Widget_Follow_Up_Datetime | String | True | |
| Widget_Status | String | True | |
| Work_Log | String | False |
Free-form text used to denote activities of interest |
The Categories table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True | |
| Is_External | Bool | False |
External category flag |
| Lft | Int | False |
Left node index |
| Locked_Fields | String | True | |
| Lvl | Int | False |
Node level |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Category name |
| Rgt | Int | False |
Right node index |
| Root | String | False |
Root ID |
| Source_Id | String | False | |
| Source_Meta | String | False | |
| Source_Type | String | False | |
| Sync_Key | String | True |
The ChangeTimers table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier |
| Name | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Modified_User_Id | String | True |
User who last modified record |
| Modified_By_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Description | String | False |
Full text of the note |
| Deleted | Bool | False |
Record deletion indicator |
| Parent_Type | String | False | |
| Parent_Id | String | False | |
| Field_Name | String | False | |
| Value_String | String | False | |
| From_Datetime | Datetime | False | |
| To_Datetime | Datetime | False | |
| Hours | Decimal | True | |
| Business_Hours | Decimal | True | |
| Following | Bool | False |
Is user following this record |
| My_Favorite | Bool | False |
Favorite for the user |
| Sync_Key | String | True |
The CJ_Forms table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier |
| Name | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Modified_User_Id | String | True |
User who last modified record |
| Modified_By_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Description | String | False |
Full text of the note |
| Deleted | Bool | False |
Record deletion indicator |
| Trigger_Event | String | False | |
| Action_Type | String | False | |
| Action_Trigger_Type | String | False | |
| Relationship | String | False | |
| Activity_Module | String | False | |
| Active | Bool | False | |
| Ignore_Errors | Bool | False | |
| Populate_Fields | String | False | |
| Select_To_Email_Address | String | False | |
| Parent_Id | String | False | |
| Parent_Name | String | True | |
| Parent_Type | String | True | |
| Display_Activity_Rsa_Icon | String | False | |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | False | |
| Email_Templates_Id | String | False | |
| Email_Templates_Name | String | True | |
| Main_Trigger_Type | String | False | |
| Module_Trigger | String | False | |
| Field_Trigger | String | False | |
| Smart_Guide_Template_Id | String | False | |
| Smart_Guide_Template_Name | String | False | |
| Target_Action | String | False | |
| Following | Bool | False |
Is user following this record |
| My_Favorite | Bool | False |
Favorite for the user |
| Tag | String | False | |
| Commentlog | String | True | |
| Locked_Fields | String | True | |
| Sync_Key | String | True | |
| Team_Id | String | False |
Team ID for the account |
| Team_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Team_Count | String | False | |
| Team_Name | String | False | |
| Acl_Team_Names | String | True |
The CJ_WebHooks table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier |
| Name | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Modified_User_Id | String | True |
User who last modified record |
| Modified_By_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Description | String | False |
Full text of the note |
| Deleted | Bool | False |
Record deletion indicator |
| Url | String | False | |
| Error_Message_Path | String | False | |
| Sort_Order | Int | False | |
| Request_Method | String | False | |
| Request_Format | String | False | |
| Response_Format | String | False | |
| Trigger_Event | String | False | |
| Request_Body | String | False | |
| Headers | String | False | |
| Custom_Post_Body | String | False | |
| Ignore_Errors | Bool | False | |
| Active | Bool | False | |
| Parent_Id | String | False | |
| Parent_Name | String | False | |
| Parent_Type | String | False | |
| Following | Bool | False |
Is user following this record |
| My_Favorite | Bool | False |
Favorite for the user |
| Tag | String | False | |
| Commentlog | String | True | |
| Locked_Fields | String | True | |
| Sync_Key | String | True | |
| Team_Id | String | False |
Team ID for the account |
| Team_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Team_Count | String | False | |
| Team_Name | String | False | |
| Acl_Team_Names | String | True |
The CloudDrivePaths table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Drive_Id | String | True | |
| Folder_Id | String | True | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Is_Root | Bool | False | |
| Is_Shared | Bool | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Path | String | True | |
| Path_Module | String | True | |
| Record_Id | String | True | |
| Site_Id | String | True | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Type | String | True |
The CommentLog table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Entry | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Tag | String | False |
The Comments table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Data | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Parent_Id | String | False | |
| Sync_Key | String | True |
The ConsoleConfiguration table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Enabled_Modules | String | False | |
| Filter_Def | String | False | |
| Following | Bool | False |
Is user following this record |
| Freeze_First_Column | Bool | False |
Decides if the first column should be frozen |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Order_By_Primary | String | False | |
| Order_By_Secondary | String | False | |
| Sync_Key | String | True | |
| Tag | String | False |
The Contacts table.
| Name | Type | ReadOnly | Description |
| Accept_Status_Calls | String | False | |
| Accept_Status_Id | String | False | |
| Accept_Status_Meetings | String | False | |
| Accept_Status_Messages | String | False | |
| Accept_Status_Name | String | False | |
| Account_Id | String | False | |
| Account_Name | String | True | |
| Accounting_Bulletins_C | Bool | False | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Alt_Address_City | String | False |
City for alternate address |
| Alt_Address_Country | String | False |
Country for alternate address |
| Alt_Address_Postalcode | String | False |
Postal code for alternate address |
| Alt_Address_State | String | False |
State for alternate address |
| Alt_Address_Street | String | False |
Street address for alternate address |
| Alt_Address_Street_2 | String | False | |
| Alt_Address_Street_3 | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Assistant | String | False |
Name of the assistant of the contact |
| Assistant_Phone | String | False |
Phone number of the assistant of the contact |
| Birthdate | Date | False |
The birthdate of the contact |
| Business_Center_Id | String | False |
The business center to which the case is associated |
| Business_Center_Name | String | True |
The name of the business center represented by the business_center_id field |
| C_Accept_Status_Fields | String | True | |
| Campaign_Id | String | False |
Campaign that generated lead |
| Campaign_Name | String | True |
The first campaign name for Contact (Meta-data only) |
| Commentlog | String | True | |
| Contact_Type_C | String | False | |
| Contactid_C | String | False | |
| Cookie_Consent | Bool | False |
Indicator whether this portal user accepts cookies |
| Cookie_Consent_Received_On | Datetime | False |
Date cookie consent received on |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Day_Of_Birth_Yr_Optional_C | String | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Department | String | False |
The department of the contact |
| Description | String | False |
Full text of the note |
| Dnb_Principal_Id | String | False |
Unique Id For DB Contact |
| Do_Not_Call | Bool | False |
An indicator of whether contact can be called |
| Dp_Business_Purpose | String | True |
Business purposes consented for |
| Dp_Consent_Last_Updated | Date | False |
Date consent last updated |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | True | |
| String | False | ||
| Email_Addresses_Non_Primary | String | False | |
| Email_And_Name1 | String | False | |
| Email_Opt_Out | Bool | False | |
| Email1 | String | False | |
| Email2 | String | False | |
| Entry_Source | String | True |
Determines if a record was created internal to the system or external to the system |
| Escrow_Bulletins_C | Bool | False | |
| String | False |
The facebook name of the user | |
| First_Name | String | False |
First name of the contact |
| Fnf_Agencies_Contacts_1_Name | String | True | |
| Fnf_Agencies_Contacts_1fnf_Agencies_Ida | String | False | |
| Following | Bool | False |
Is user following this record |
| Full_Name | String | True | |
| General_Bulletins_C | Bool | False | |
| Googleplus | String | False |
The google plus id of the user |
| Hint_Account_Annual_Revenue | String | False |
Annual Rev |
| Hint_Account_Description | String | False |
Company Description |
| Hint_Account_Facebook_Handle | String | False |
company facebook |
| Hint_Account_Fiscal_Year_End | String | False |
FY End |
| Hint_Account_Founded_Year | String | False |
company founded year |
| Hint_Account_Industry | String | False |
Company Industry |
| Hint_Account_Location | String | False |
Company Location |
| Hint_Account_Logo | String | False |
company logo |
| Hint_Account_Naics_Code_Lbl | String | False |
NAICS Code |
| Hint_Account_Sic_Code_Label | String | False |
SIC Code |
| Hint_Account_Size | String | False |
Company Size |
| Hint_Account_Twitter_Handle | String | False |
company twitter |
| Hint_Account_Website | String | False |
company website |
| Hint_Contact_Pic | String | False |
Hint Contact logo |
| Hint_Education | String | False |
Education |
| Hint_Education_2 | String | False |
Education 2 |
| Hint_Facebook | String | False | |
| Hint_Industry_Tags | String | False |
industry tags |
| Hint_Job_2 | String | False |
Job 2 |
| Hint_Phone_1 | String | False |
extra phone field |
| Hint_Phone_2 | String | False |
extra phone field |
| Hint_Photo | String | False |
person photo |
| Hint_Twitter | String | False | |
| Id [KEY] | String | True |
Unique identifier |
| Invalid_Email | Bool | False | |
| Last_Name | String | False |
Last name of the contact |
| Lead_Registered_User_C | Bool | False | |
| Lead_Source | String | False |
How did the contact come about |
| Locked_Fields | String | True | |
| M_Accept_Status_Fields | String | True | |
| Market_Interest_Prediction_Score | String | True | |
| Market_Score | Int | True | |
| Mkto_Id | Int | True |
Associated Marketo Lead ID |
| Mkto_Lead_Score | Int | True | |
| Mkto_Sync | Bool | False |
Should the Lead be synced to Marketo |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | True | |
| No_Longer_At_Account_C | Bool | False | |
| Opportunity_Role | String | False | |
| Opportunity_Role_Fields | String | True | |
| Opportunity_Role_Id | String | False | |
| Owner_Only_Bulletins_C | Bool | False | |
| Perform_Sugar_Action | Bool | False | |
| Phone_Fax | String | False |
Contact fax number |
| Phone_Home | String | False |
Home phone number of the contact |
| Phone_Mobile | String | False |
Mobile phone number of the contact |
| Phone_Other | String | False |
Other phone number for the contact |
| Phone_Work | String | False |
Work phone number of the contact |
| Picture | String | False |
Avatar |
| Portal_Active | Bool | False |
Indicator whether this contact is a portal user |
| Portal_App | String | False |
Reference to the portal |
| Portal_Name | String | True |
Name as it appears in the portal |
| Portal_Password | String | True | |
| Portal_Password1 | String | True | |
| Portal_User_Company_Name | String | False |
User company name in the portal |
| Preferred_Language | String | False | |
| Primary_Address_City | String | False |
City for primary address |
| Primary_Address_Country | String | False |
Country for primary address |
| Primary_Address_Postalcode | String | False |
Postal code for primary address |
| Primary_Address_State | String | False |
State for primary address |
| Primary_Address_Street | String | False |
The street address used for primary address |
| Primary_Address_Street_2 | String | False | |
| Primary_Address_Street_3 | String | False | |
| Report_To_Name | String | True | |
| Reports_To_Id | String | False |
The contact this contact reports to |
| Salutation | String | False |
Contact salutation (e.g., Mr, Ms) |
| Site_User_Id | String | True | |
| Source_Id | String | False | |
| Source_Meta | String | False | |
| Source_Type | String | False | |
| Sync_Contact | Bool | False |
Synch to outlook? (Meta-Data only) |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Title | String | False |
The title of the contact |
| Title_Wave_User_C | Bool | False | |
| String | False |
The twitter name of the user | |
| Underwriting_Bulletins_C | Bool | False |
The Contracts table.
| Name | Type | ReadOnly | Description |
| Account_Id | String | False |
The account ID to which the contract is associated |
| Account_Name | String | False | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Commentlog | String | True | |
| Company_Signed_Date | Date | False |
Date in which the company using Sugar signed the contract |
| Contract_Term | Int | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Customer_Signed_Date | Date | False |
Date in which the ultimate customer signed the contract |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| End_Date | Date | False |
The date in which the contract is no longer effective |
| Expiration_Notice | Datetime | False |
Date to issue an expiration notice (useful for workflow rules) |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
The name of the contract |
| Opportunity_Id | String | False | |
| Opportunity_Name | String | True | |
| Parent_Name | String | True |
parent_name of contract, added to prevent ability to add flex relate field to module because of relationship in linked_documentsMetaData.php |
| Reference_Code | String | False |
The reference code used by the organization to refer to this contract |
| Start_Date | Date | False |
The effective date of the contract |
| Status | String | False |
The contract status |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Time_To_Expiry | Int | True | |
| Total_Contract_Value | Decimal | True |
The overall value of the contract |
| Total_Contract_Value_Usdollar | Decimal | True |
The overall contract value expressed in USD |
| Type | String | False |
The dropdown options for Contract types |
| Type_Name | String | True |
The contract type |
The ContractTypes table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| List_Order | Int | True |
Relative order in drop down list |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Tag | String | False |
The Currencies table.
| Name | Type | ReadOnly | Description |
| Conversion_Rate | Decimal | False |
Conversion rate factor (relative to stored value) |
| Created_By | String | True |
User ID who created record |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Id [KEY] | String | True |
Unique identifer |
| Iso4217 | String | False |
3-letter identifier specified by ISO 4217 (ex: USD) |
| Name | String | False |
Name of the currency |
| Status | String | False |
Currency status |
| Symbol | String | False |
Symbol representing the currency |
| Sync_Key | String | True |
The CustomQueries table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Created_By | String | True |
User ID who created record |
| Custom_Query | String | False |
The SQL statement |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full description of the custom query |
| Id [KEY] | String | True |
Unique identifer |
| List_Order | Int | True |
The relative order of this query (unused) |
| Modified_User_Id | String | True |
User who last modified record |
| Name | String | False |
Name of the custom query |
| Query_Locked | Bool | False |
Indicates whether query body (the SQL statement) can be changed |
| Query_Type | String | False |
The type of query (unused) |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The Dashboards table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Dashboard_Module | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Default_Dashboard | Bool | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Metadata | String | False | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| View_Name | String | False |
The DataArchiver table.
| Name | Type | ReadOnly | Description |
| Active | Bool | False |
Whether the definition is active or not |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Filter_Def | String | False |
The filter definitions defined for the archive |
| Filter_Module_Name | String | False |
Module associated with the archived data |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Process_Type | String | False |
Whether the data should be truncated or archived |
| Sync_Key | String | True | |
| Tag | String | False |
The DataPrivacy table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Business_Hours_To_Resolution | Decimal | True |
How long it took to resolve this issue, in decimal business hours |
| Business_Purpose | String | True |
Business purpose |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Dataprivacy_Number | Int | False |
Visual unique identifier |
| Date_Closed | Date | False |
Date closed |
| Date_Due | Date | False |
Due date |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Opened | Date | False |
Date opened |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Fields_To_Erase | String | False | |
| Follow_Up_Datetime | Datetime | False |
Deadline for following up on an issue |
| Following | Bool | False |
Is user following this record |
| Hours_To_Resolution | Decimal | True |
How long it took to resolve this issue, in decimal calendar hours |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
The short description of the bug |
| Pending_Processing | Bool | True | |
| Priority | String | False |
An indication of the priorty of the issue |
| Requested_By | String | False |
Requested by |
| Resolution | String | False |
The resolution of the request |
| Resolved_Datetime | Datetime | False |
Date when an issue is resolved |
| Source | String | False |
The source of the request |
| Status | String | False |
The status of the request |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Type | String | False |
The type of request |
| Widget_Follow_Up_Datetime | String | True | |
| Work_Log | String | False |
Free-form text used to denote activities of interest |
The DataSets table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Body_Back_Color | String | False | |
| Body_Text_Color | String | False | |
| Created_By | String | True | |
| Custom_Layout | String | False | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| Description | String | False | |
| Exportable | Bool | False | |
| Font_Size | String | False | |
| Header | Bool | False | |
| Header_Back_Color | String | False | |
| Header_Text_Color | String | False | |
| Id [KEY] | String | True | |
| List_Order_Y | Int | True | |
| Modified_User_Id | String | True | |
| Name | String | False | |
| Output_Default | String | False | |
| Parent_Id | String | False | |
| Parent_Name | String | True |
Parent data sets for the data set (Meta-data only) |
| Prespace_Y | Bool | False | |
| Query_Id | String | False | |
| Query_Name | String | False |
Custom Queries for the data sets (Meta-data only) |
| Report_Id | String | False | |
| Report_Name | String | False |
Custom Queries for the data sets (Meta-data only) |
| Table_Width | String | False | |
| Table_Width_Type | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Use_Prev_Header | Bool | False |
The DocumentMerges table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Dismissed | Bool | False | |
| File_Type | String | True | |
| Flow_Data | String | False | |
| Following | Bool | False |
Is user following this record |
| Generated_Document_Id | String | True | |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Merge_Type | String | True | |
| Message | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Parent_Id | String | True | |
| Parent_Name | String | True | |
| Parent_Type | String | True | |
| Record_Ids | String | True |
store the record ids for the multimerge |
| Seen | Bool | False | |
| Status | String | True | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Template | String | True | |
| Template_Id | String | True |
The DocumentRevisions table.
| Name | Type | ReadOnly | Description |
| Change_Log | String | False | |
| Created_By | String | True | |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| Doc_Id | String | False |
Document ID from documents web server provider |
| Doc_Type | String | False |
Document type (ex: Google, box.net, IBM SmartCloud) |
| Doc_Url | String | False |
Document URL from documents web server provider |
| Document_Id | String | False | |
| Document_Name | String | False | |
| File_Ext | String | False | |
| File_Mime_Type | String | False | |
| File_Size | Int | True |
The size of the file |
| Filename | String | False | |
| Id [KEY] | String | True | |
| Latest_Revision | String | False | |
| Latest_Revision_Id | String | False | |
| Related_Document_Name | String | True | |
| Revision | String | False |
The Documents table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Active_Date | Date | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Category_Id | String | False | |
| Commentlog | String | True | |
| Contract_Name | String | False | |
| Contract_Status | String | False | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Doc_Id | String | False |
Document ID from documents web server provider |
| Doc_Type | String | True |
Document type (ex: Google, box.net, IBM SmartCloud) |
| Doc_Url | String | False |
Document URL from documents web server provider |
| Document_Name | String | False | |
| Document_Revision_Id | String | False | |
| Exp_Date | Date | False | |
| Filename | String | False |
The filename of the document attachment |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Is_Shared | Bool | False | |
| Is_Template | Bool | False | |
| Last_Rev_Create_Date | String | True | |
| Last_Rev_Created_Name | String | False | |
| Last_Rev_Mime_Type | String | False | |
| Latest_Revision | String | False | |
| Latest_Revision_File_Ext | String | True | |
| Latest_Revision_File_Mime_Type | String | True | |
| Latest_Revision_File_Size | String | True | |
| Latest_Revision_Id | String | False | |
| Latest_Revision_Name | String | False | |
| Linked_Id | String | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Related_Doc_Id | String | False | |
| Related_Doc_Name | String | True |
The related document name for Meta-Data framework |
| Related_Doc_Rev_Id | String | False | |
| Related_Doc_Rev_Number | String | True |
The related document version number for Meta-Data framework |
| Revision | String | False | |
| Selected_Revision_Filename | String | False | |
| Selected_Revision_Id | String | False | |
| Selected_Revision_Name | String | False | |
| Status | String | False |
Document status for Meta-Data framework |
| Status_Id | String | False | |
| Subcategory_Id | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Template_Type | String | False |
The DocumentTemplates table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| File_Ext | String | False | |
| File_Mime_Type | String | False | |
| File_Size | Int | True |
The size of the file |
| Filename | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Label_Merging | Bool | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Postfix | String | False | |
| Prefix | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Template_Module | String | False | |
| Use_Revisions | Bool | False |
The DocuSignEnvelopes table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Cloud_Path | String | False | |
| Cloud_Service_Type | String | False | |
| Commentlog | String | True | |
| Completed_Document | String | True |
The document completed in DocuSign |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Document_Id | String | False | |
| Driveid | String | False | |
| Envelope_Id | String | True |
The id of the envelope in DocuSign |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Last_Audit | Datetime | False |
The last time the envelope was fetched from DocuSign |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Parent_Id | String | False | |
| Parent_Name | String | True |
The parent record |
| Parent_Type | String | True | |
| Status | String | True |
The status of the envelope |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The DRI_SubWorkflows table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier |
| Name | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Modified_User_Id | String | True |
User who last modified record |
| Modified_By_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Description | String | False |
Full text of the note |
| Deleted | Bool | False |
Record deletion indicator |
| Label | String | False | |
| State | String | False | |
| Start_Next_Journey_Id | String | False | |
| Progress | Double | True | |
| Momentum_Ratio | Double | True | |
| Score | Int | True | |
| Points | Int | True | |
| Momentum_Points | Int | True | |
| Momentum_Score | Int | True | |
| Sort_Order | Int | False | |
| Date_Started | Datetime | True | |
| Date_Completed | Datetime | True | |
| Is_Journey_Saved | Bool | False | |
| Dri_Subworkflow_Template_Id | String | False | |
| Dri_Subworkflow_Template_Name | String | True | |
| Dri_Workflow_Id | String | False | |
| Dri_Workflow_Name | String | False | |
| Following | Bool | False |
Is user following this record |
| My_Favorite | Bool | False |
Favorite for the user |
| Tag | String | False | |
| Commentlog | String | True | |
| Locked_Fields | String | True | |
| Sync_Key | String | True | |
| Team_Id | String | False |
Team ID for the account |
| Team_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Team_Count | String | False | |
| Team_Name | String | False | |
| Acl_Team_Names | String | True | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True |
The DRI_SubWorkflow_Templates table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier |
| Name | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Modified_User_Id | String | True |
User who last modified record |
| Modified_By_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Description | String | False |
Full text of the note |
| Deleted | Bool | False |
Record deletion indicator |
| Label | String | False | |
| Sort_Order | Int | True | |
| Points | Int | True | |
| Related_Activities | Int | True | |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | False | |
| Start_Next_Journey_Id | String | False | |
| Start_Next_Journey_Name | String | True | |
| Following | Bool | False |
Is user following this record |
| My_Favorite | Bool | False |
Favorite for the user |
| Tag | String | False | |
| Commentlog | String | True | |
| Locked_Fields | String | True | |
| Sync_Key | String | True | |
| Team_Id | String | False |
Team ID for the account |
| Team_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Team_Count | String | False | |
| Team_Name | String | False | |
| Acl_Team_Names | String | True |
The DRI_Workflows table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier |
| Name | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Modified_User_Id | String | True |
User who last modified record |
| Modified_By_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Description | String | True |
Full text of the note |
| Deleted | Bool | False |
Record deletion indicator |
| Available_Modules | String | True | |
| Enabled_Modules | String | True | |
| State | String | False | |
| Assignee_Rule | String | False | |
| Target_Assignee | String | False | |
| Stage_Numbering | String | True | |
| Progress | Double | True | |
| Momentum_Ratio | Double | True | |
| Score | Int | True | |
| Points | Int | True | |
| Momentum_Points | Int | True | |
| Momentum_Score | Int | True | |
| Date_Started | Datetime | True | |
| Date_Completed | Datetime | True | |
| Archived | Bool | False | |
| Is_Cancelled | Bool | False | |
| Is_Deleted | Bool | False | |
| Current_Stage_Id | String | False | |
| Current_Stage_Name | String | True | |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | False | |
| Parent_Id | String | True | |
| Parent_Name | String | True | |
| Parent_Type | String | True | |
| Following | Bool | False |
Is user following this record |
| My_Favorite | Bool | False |
Favorite for the user |
| Tag | String | False | |
| Commentlog | String | True | |
| Locked_Fields | String | True | |
| Sync_Key | String | True | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Team_Id | String | False |
Team ID for the account |
| Team_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Team_Count | String | False | |
| Team_Name | String | False | |
| Acl_Team_Names | String | True | |
| Contact_Id | String | False | |
| Contact_Name | String | True | |
| Account_Id | String | False | |
| Account_Name | String | True | |
| Opportunity_Id | String | False | |
| Opportunity_Name | String | True | |
| Case_Id | String | False | |
| Case_Name | String | True | |
| Lead_Id | String | False | |
| Lead_Name | String | True |
The DRI_Workflow_Task_Templates table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier |
| Name | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Modified_User_Id | String | True |
User who last modified record |
| Modified_By_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Description | String | False |
Full text of the note |
| Deleted | Bool | False |
Record deletion indicator |
| Task_Start_Date_Type | String | False | |
| Task_Due_Date_Type | String | False | |
| Momentum_Start_Type | String | False | |
| Start_Date_Module | String | False | |
| Due_Date_Module | String | False | |
| Start_Date_Field | String | False | |
| Due_Date_Field | String | False | |
| Due_Date_Criteria | String | False | |
| Momentum_Start_Module | String | False | |
| Momentum_Start_Field | String | False | |
| Priority | String | False | |
| Type | String | False | |
| Activity_Type | String | False | |
| Duration_Minutes | String | False | |
| Direction | String | False | |
| Points | String | False | |
| Momentum_Points | String | False | |
| Send_Invite_Type | String | False | |
| Target_Assignee | String | False | |
| Assignee_Rule | String | False | |
| Populate_Fields | String | False | |
| Select_To_Guests | String | False | |
| Allow_Activity_By | String | False | |
| Time_Of_Day | String | False | |
| Sort_Order | String | False | |
| Task_Start_Days | Int | False | |
| Task_Due_Days | Int | False | |
| Momentum_Due_Days | Int | False | |
| Momentum_Due_Hours | Int | False | |
| Duration_Hours | Int | True | |
| Duration | Int | True | |
| Is_Parent | Bool | True | |
| Blocked_By | String | False | |
| Blocked_By_Stages | String | False | |
| Url | String | False | |
| Stage_Template_Label | String | True | |
| Stage_Template_Sort_Order | String | True | |
| Assignee_Rule_Activity_Id | String | False | |
| Assignee_Rule_Activity_Name | String | False | |
| Start_Date_Activity_Id | String | False | |
| Start_Date_Activity_Name | String | False | |
| Due_Date_Activity_Id | String | False | |
| Due_Date_Activity_Name | String | False | |
| Momentum_Start_Activity_Id | String | False | |
| Momentum_Start_Activity_Name | String | False | |
| Parent_Id | String | False | |
| Parent_Name | String | True | |
| Dri_Subworkflow_Template_Id | String | False | |
| Dri_Subworkflow_Template_Name | String | False | |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | False | |
| Start_Next_Journey_Id | String | False | |
| Start_Next_Journey_Name | String | True | |
| Target_Assignee_User_Id | String | False | |
| Target_Assignee_User_Name | String | False | |
| Target_Assignee_Team_Id | String | False | |
| Target_Assignee_Team_Name | String | False | |
| Following | Bool | False |
Is user following this record |
| My_Favorite | Bool | False |
Favorite for the user |
| Tag | String | False | |
| Commentlog | String | True | |
| Locked_Fields | String | True | |
| Sync_Key | String | True | |
| Team_Id | String | False |
Team ID for the account |
| Team_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Team_Count | String | False | |
| Team_Name | String | False | |
| Acl_Team_Names | String | True |
The DRI_Workflow_Templates table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier |
| Name | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Modified_User_Id | String | True |
User who last modified record |
| Modified_By_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Description | String | False |
Full text of the note |
| Deleted | Bool | False |
Record deletion indicator |
| Available_Modules | String | False | |
| Disabled_Stage_Actions | String | True | |
| Disabled_Activity_Actions | String | True | |
| Active_Limit | Int | True | |
| Points | Int | True | |
| Related_Activities | Int | True | |
| Active | Bool | False | |
| Update_Assignees | Bool | False | |
| Assignee_Rule | String | False | |
| Target_Assignee | String | False | |
| Stage_Numbering | String | True | |
| Cancel_Action | String | False | |
| Not_Applicable_Action | String | False | |
| Copied_Template_Id | String | False | |
| Copied_Template_Name | String | True | |
| Following | Bool | False |
Is user following this record |
| My_Favorite | Bool | False |
Favorite for the user |
| Tag | String | False | |
| Commentlog | String | True | |
| Locked_Fields | String | True | |
| Sync_Key | String | True | |
| Team_Id | String | False |
Team ID for the account |
| Team_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Team_Count | String | False | |
| Team_Name | String | False | |
| Acl_Team_Names | String | True |
The EAPM table.
| Name | Type | ReadOnly | Description |
| Api_Data | String | False |
Any API data that the external API may wish to store on a per-user basis |
| Application | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Consumer_Key | String | False | |
| Consumer_Secret | String | False | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Note | String | False | |
| Oauth_Secret | String | False | |
| Oauth_Token | String | False | |
| Password | String | False | |
| Sync_Key | String | True | |
| Url | String | False | |
| Validated | Bool | False |
The EmailAddresses table.
| Name | Type | ReadOnly | Description |
| Confirmation_Requested_On | Datetime | False | |
| Date_Created | Datetime | False | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| Email_Address | String | False | |
| Email_Address_Caps | String | False | |
| Id [KEY] | String | True | |
| Invalid_Email | Bool | False | |
| Opt_Out | Bool | False |
The EmailMarketing table.
| Name | Type | ReadOnly | Description |
| All_Prospect_Lists | Bool | False | |
| Campaign_Id | String | False | |
| Created_By | String | True | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Date_Start | Datetime | False | |
| Deleted | Bool | False | |
| From_Addr | String | False | |
| From_Name | String | False | |
| Id [KEY] | String | True | |
| Inbound_Email_Id | String | False | |
| Modified_User_Id | String | True | |
| Name | String | False | |
| Prospect_List_Name | String | False | |
| Reply_To_Addr | String | False | |
| Reply_To_Name | String | False | |
| Status | String | False | |
| Template_Id | String | False | |
| Template_Name | String | True |
The EmailParticipants table.
| Name | Type | ReadOnly | Description |
| Address_Type | String | False |
The role (from, to, cc, bcc) that the entry plays in the email |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| Email_Address | String | True | |
| Email_Address_Id | String | False | |
| Email_Id | String | False | |
| Id [KEY] | String | True | |
| Invalid_Email | String | True | |
| Opt_Out | String | True | |
| Parent_Id | String | False |
The bean's ID |
| Parent_Name | String | True | |
| Parent_Type | String | True |
The Emails table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID that last modified record |
| Assigned_User_Name | String | True | |
| Attachments_Collection | String | True | |
| Bcc_Addrs_Names | String | False | |
| Bcc_Collection | String | True | |
| Cc_Addrs_Names | String | False | |
| Cc_Collection | String | True | |
| Created_By | String | True |
User name who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Sent | Datetime | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False | |
| Description_Html | String | True | |
| Direction | String | False |
Email direction is one of Unknown, Outbound, Inbound, Internal |
| Flagged | Bool | False |
flagged status |
| Following | Bool | False |
Is user following this record |
| From_Addr_Name | String | False | |
| From_Collection | String | True | |
| Id [KEY] | String | True |
Unique identifier |
| Intent | String | False |
Target of action used in Inbound Email assignment |
| Mailbox_Id | String | False | |
| Mailbox_Name | String | True | |
| Message_Id | String | False |
ID of the email item obtained from the email transport system |
| Message_Uid | String | False |
UID of the email item obtained from the email transport system |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User ID that last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
The subject of the email |
| Outbound_Email_Id | String | False |
The configuration used to send an email, only used for emails sent using SugarCRM |
| Parent_Id | String | False |
ID of Sugar object referenced by parent_type |
| Parent_Name | String | True | |
| Parent_Type | String | True |
Identifier of Sugar module to which this email is associated |
| Raw_Source | String | False | |
| Reply_To_Addr | String | False | |
| Reply_To_Id | String | False |
Identifier of email record that this email was a reply to |
| Reply_To_Status | Bool | False |
If you reply to an email then reply to status of original email is set |
| State | String | False |
An email is either a draft or archived |
| Status | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| To_Addrs_Names | String | False | |
| To_Collection | String | True | |
| Total_Attachments | Int | True | |
| Type | String | False |
Type of email (ex: draft) |
The EmailTemplates table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Attachments_Collection | String | True | |
| Base_Module | String | False |
In Workflow alert templates, the module to which this template is associated |
| Body | String | False |
Plain text body to be used in resulting email |
| Body_Html | String | True |
HTML formatted email body to be used in resulting email |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Email template description |
| From_Address | String | False | |
| From_Name | String | False | |
| Has_Variables | Bool | True | |
| Id [KEY] | String | True |
Unique identifier |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| Name | String | False |
Email template name |
| Published | String | False | |
| Subject | String | False |
Email subject to be used in resulting email |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Text_Only | Bool | False |
Should be checked if email template is to be sent in text only |
| Type | String | False |
Type of the email template |
The EmbeddedFiles table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| File_Mime_Type | String | False | |
| Filename | String | True | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True |
The Employees table.
| Name | Type | ReadOnly | Description |
| Accept_Status_Calls | String | False | |
| Accept_Status_Id | String | False | |
| Accept_Status_Meetings | String | False | |
| Accept_Status_Messages | String | False | |
| Accept_Status_Name | String | False | |
| Acl_Role_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Address_City | String | False | |
| Address_Country | String | False | |
| Address_Postalcode | String | False | |
| Address_State | String | False | |
| Address_Street | String | False | |
| Authenticate_Id | String | False | |
| Business_Center_Id | String | False |
The business center to which the case is associated |
| Business_Center_Name | String | True |
The name of the business center represented by the business_center_id field |
| C_Accept_Status_Fields | String | True | |
| Cookie_Consent | Bool | False |
Indicator whether this user accepts cookies |
| Cookie_Consent_Received_On | Datetime | False |
Date cookie consent received on |
| Created_By | String | True | |
| Created_By_Name | String | True | |
| Customer_Journey_Access | Bool | True | |
| Customer_Journey_Last_Active | Datetime | True | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Default_Team | String | False | |
| Deleted | Bool | False | |
| Department | String | False | |
| Description | String | False | |
| String | False | ||
| Email_Link_Type | String | False | |
| Email1 | String | False | |
| Employee_Status | String | False | |
| External_Auth_Only | Bool | False | |
| First_Name | String | False | |
| Full_Name | String | True | |
| Id [KEY] | String | True | |
| Is_Admin | Bool | False | |
| Is_Group | Bool | False | |
| Last_Login | Datetime | True | |
| Last_Name | String | False | |
| License_Type | String | False | |
| M_Accept_Status_Fields | String | True | |
| Messenger_Id | String | False | |
| Messenger_Type | String | False | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True | |
| Name | String | True | |
| Phone_Fax | String | False | |
| Phone_Home | String | False | |
| Phone_Mobile | String | False | |
| Phone_Other | String | False | |
| Phone_Work | String | False | |
| Picture | String | False | |
| Portal_Only | Bool | False | |
| Preferred_Language | String | False | |
| Pwd_Last_Changed | Datetime | False | |
| Receive_Notifications | Bool | False | |
| Reports_To_Id | String | False | |
| Reports_To_Name | String | True | |
| Send_Email_On_Mention | Bool | False | |
| Show_On_Employees | Bool | False | |
| Site_User_Id | String | True | |
| Status | String | False | |
| Sugar_Login | Bool | False | |
| Sync_Key | String | True | |
| System_Generated_Password | Bool | False | |
| Team_Count | String | False | |
| Team_Id | String | False | |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Title | String | False | |
| User_Hash | String | True | |
| User_Name | String | False | |
| Usertype | String | False |
The Escalations table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Escalation_Number | Int | False |
Visual unique identifier |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Parent_Id | String | False |
The ID of the parent Sugar object identified by parent_type |
| Parent_Name | String | False | |
| Parent_Type | String | False |
The Sugar object to which the call is related |
| Reason | String | False |
The reason given for the escalation |
| Source | String | False |
The source of the escalation |
| Status | String | False |
The status of the escalation |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The ExternalUsers table.
| Name | Type | ReadOnly | Description |
| Salutation | String | False |
Contact salutation (e.g., Mr, Ms) |
| First_Name | String | False |
First name of the contact |
| Last_Name | String | False |
Last name of the contact |
| Name | String | False | |
| Full_Name | String | True | |
| Title | String | False |
The title of the contact |
| String | False |
The facebook name of the user | |
| String | False |
The twitter name of the user | |
| Googleplus | String | False |
The google plus id of the user |
| Department | String | False |
The department of the contact |
| Do_Not_Call | Bool | False |
An indicator of whether contact can be called |
| Phone_Home | String | False |
Home phone number of the contact |
| Phone_Mobile | String | False |
Mobile phone number of the contact |
| Phone_Work | String | False |
Work phone number of the contact |
| Phone_Other | String | False |
Other phone number for the contact |
| Phone_Fax | String | False |
Contact fax number |
| Primary_Address_Street | String | False |
The street address used for primary address |
| Primary_Address_Street_2 | String | False | |
| Primary_Address_Street_3 | String | False | |
| Primary_Address_City | String | False |
City for primary address |
| Primary_Address_State | String | False |
State for primary address |
| Primary_Address_Postalcode | String | False |
Postal code for primary address |
| Primary_Address_Country | String | False |
Country for primary address |
| Alt_Address_Street | String | False |
Street address for alternate address |
| Alt_Address_Street_2 | String | False | |
| Alt_Address_Street_3 | String | False | |
| Alt_Address_City | String | False |
City for alternate address |
| Alt_Address_State | String | False |
State for alternate address |
| Alt_Address_Postalcode | String | False |
Postal code for alternate address |
| Alt_Address_Country | String | False |
Country for alternate address |
| Assistant | String | False |
Name of the assistant of the contact |
| Assistant_Phone | String | False |
Phone number of the assistant of the contact |
| Picture | String | False |
Avatar |
| Id [KEY] | String | False |
Unique identifier |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Modified_User_Id | String | True |
User who last modified record |
| Modified_By_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Description | String | False |
Full text of the note |
| Deleted | Bool | False |
Record deletion indicator |
| User_Name | String | False |
Username of the external user |
| Status | String | False |
Status of the external user |
| External_App | String | False |
External application which creates the external user |
| External_Id | String | False |
External id of the external user |
| Contact_Name | String | True | |
| Contact_Id | String | False |
Contact ID the external user is associated with |
| String | False | ||
| Email1 | String | False | |
| Email2 | String | False | |
| Invalid_Email | Bool | False | |
| Email_Opt_Out | Bool | False | |
| Email_Addresses_Non_Primary | String | False | |
| Tag | String | False | |
| Source_Id | String | False | |
| Source_Type | String | False | |
| Source_Meta | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Team_Id | String | False |
Team ID for the account |
| Team_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Team_Count | String | False | |
| Team_Name | String | False | |
| Acl_Team_Names | String | True | |
| Following | Bool | False |
Is user following this record |
| My_Favorite | Bool | False |
Favorite for the user |
| Commentlog | String | True | |
| Locked_Fields | String | True | |
| Sync_Key | String | True |
The Filters table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| App | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Filter_Definition | String | False | |
| Filter_Template | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| Module_Name | String | False | |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The ForecastManagerWorksheets table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Best_Case | Decimal | True | |
| Best_Case_Adjusted | Decimal | True | |
| Closed_Amount | Decimal | True |
Total of closed won items in the forecast |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Draft | Bool | False | |
| Draft_Save_Type | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Is_Manager | Bool | False |
needed for commitLog field logic |
| Likely_Case | Decimal | True | |
| Likely_Case_Adjusted | Decimal | True | |
| Locked_Fields | String | True | |
| Manager_Saved | Bool | False | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Opp_Count | Int | True |
Number of opportunities represented by this forecast |
| Pipeline_Amount | Decimal | True |
Total of opportunities minus closed won/closed lost represented by this forecast |
| Pipeline_Opp_Count | Int | True |
Number of opportunities minus closed won/closed lost represented by this forecast |
| Quota | Decimal | True | |
| Show_History_Log | Int | True | |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Timeperiod_Id | String | False | |
| User_Id | String | False | |
| Worst_Case | Decimal | True | |
| Worst_Case_Adjusted | Decimal | True |
The Forecasts table.
| Name | Type | ReadOnly | Description |
| Base_Rate | String | False | |
| Best_Case | Decimal | True |
Best case forecast amount |
| Closed_Amount | Decimal | True |
Total of closed won items in the forecast |
| Closed_Count | Int | True |
This is used by the commit code to determine how many closed opps exist for the pipeline calc |
| Commit_Type | String | True |
This is used by the commit code to figure out what type of worksheet we are committing |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record modified |
| Deleted | Bool | False |
Record deletion indicator |
| End_Date | Date | False | |
| Forecast_Type | String | False |
Indicator of whether forecast is direct or rollup |
| Id [KEY] | String | True |
Unique identifier |
| Likely_Case | Decimal | True |
Likely case forecast amount |
| Name | String | False | |
| Opp_Count | Int | True |
Number of opportunities represented by this forecast |
| Opp_Weigh_Value | Int | True |
Weighted amount of all opportunities represented by this forecast |
| Pipeline_Amount | Decimal | True |
Total of opportunities minus closed won/closed lost represented by this forecast |
| Pipeline_Opp_Count | Int | True |
Number of opportunities minus closed won/closed lost represented by this forecast |
| Reports_To_User_Name | String | True | |
| Start_Date | Date | False | |
| Timeperiod_Id | String | False |
ID of the associated time period for this forecast |
| User_Id | String | False |
User to which this forecast pertains |
| User_Name | String | True | |
| Worst_Case | Decimal | True |
Worst case likely amount |
The ForecastWorksheets table.
| Name | Type | ReadOnly | Description |
| Account_Id | String | False | |
| Account_Name | String | True | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Best_Case | Decimal | True | |
| Campaign_Id | String | False | |
| Campaign_Name | String | True | |
| Category_Id | String | False | |
| Category_Name | String | True | |
| Commit_Stage | String | False |
Forecast commit ranges: Include, Likely, Omit etc. |
| Cost_Price | Decimal | True |
Product cost ( |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Closed | Date | False |
Expected or actual date the oppportunity will close |
| Date_Closed_Timestamp | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Discount_Amount | Decimal | True |
Discounted amount |
| Discount_Price | Decimal | True |
Discounted price ( |
| Draft | Int | True |
Is A Draft Version |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Lead_Source | String | False |
Source of the product |
| Likely_Case | Decimal | True | |
| List_Price | Decimal | True |
List price of product ( |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Next_Step | String | False |
The next step in the sales process |
| Opportunity_Id | String | False | |
| Opportunity_Name | String | True | |
| Parent_Deleted | Int | True |
Is Parent Deleted |
| Parent_Id | String | False |
Account ID of the parent of this account |
| Parent_Name | String | True | |
| Parent_Type | String | True |
Sugar module the Worksheet is associated with |
| Probability | Int | True |
The probability of closure |
| Product_Template_Id | String | False | |
| Product_Template_Name | String | True | |
| Product_Type | String | False |
Type of product ( from opportunities opportunity_type ex: Existing, New) |
| Quantity | Int | True |
Quantity in use |
| Sales_Stage | String | False |
Indication of progression towards closure |
| Sales_Status | String | False | |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Total_Amount | Decimal | True | |
| Worst_Case | Decimal | True |
The Geocode table.
| Name | Type | ReadOnly | Description |
| Address | String | False | |
| Country | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Error_Message | String | False | |
| Geocoded | Bool | False | |
| Id [KEY] | String | True |
Unique identifier |
| Latitude | Decimal | True | |
| Longitude | Decimal | True | |
| Parent_Id | String | False | |
| Parent_Name | String | False | |
| Parent_Type | String | False | |
| Parent_User_Name | String | False | |
| Postalcode | String | False | |
| Status | String | False |
The HintAccountsets table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Category | String | False | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Targets | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Type | String | False |
The HintEnrichFieldConfigs table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Config_Data | String | False | |
| Created | Datetime | False | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Synced | Bool | False | |
| Tag | String | False |
The HintNewsNotifications table.
| Name | Type | ReadOnly | Description |
| Article_Date | Datetime | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Category | String | False | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Photo_Url | String | False | |
| Publisher | String | False | |
| Source_Url | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Title | String | False |
The HintNotificationTargets table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Credentials | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Type | String | False |
The Holidays table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False | |
| Description | String | False | |
| Holiday_Date | Date | False | |
| Id [KEY] | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True | |
| Name | String | False | |
| Person_Id | String | False | |
| Person_Type | String | False | |
| Related_Module | String | False | |
| Related_Module_Id | String | False | |
| Resource_Name | String | False |
The InboundEmail table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Auth_Type | String | True | |
| Authorized_Account | String | True | |
| Created_By | String | True |
User who created record |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Delete_Seen | Bool | False |
Delete email from server once read (seen) |
| Deleted | Bool | False |
Record deltion indicator |
| Eapm_Id | String | True | |
| Email_Password | String | False |
Password of user identified by email_user |
| Email_Provider | String | False | |
| Email_User | String | False |
User name allowed access to mail server |
| Group_Id | String | False |
Group ID (unused) |
| Groupfolder_Id | String | False |
Unique identifier |
| Id [KEY] | String | True |
Unique identifier |
| Is_Personal | Bool | False |
Personal account flag |
| Mailbox | String | False | |
| Mailbox_Type | String | False | |
| Modified_User_Id | String | True |
User who last modified record |
| Name | String | False |
Name given to the inbound email mailbox |
| Port | Int | False |
Port used to access mail server |
| Server_Url | String | False |
Mail server URL |
| Service | String | False | |
| Status | String | False |
Status of the inbound email mailbox (ex: Active or Inactive) |
| Stored_Options | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Template_Id | String | False |
Template used for auto-reply |
The KBArticles table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Kbdocument_Id | String | False | |
| Kbdocument_Name | String | True | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The KBContents table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Active_Date | Date | False | |
| Active_Rev | String | True |
Active revision flag |
| Approved | Bool | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Attachment_List | String | True | |
| Category_Id | String | False |
Category ID |
| Category_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Exp_Date | Date | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Is_External | String | True |
External article flag |
| Kbarticle_Id | String | False | |
| Kbarticle_Name | String | True | |
| Kbdocument_Body | String | True |
Article body |
| Kbdocument_Id | String | False | |
| Kbdocument_Name | String | True | |
| Kbsapprover_Id | String | False |
User who approved article |
| Kbsapprover_Name | String | True | |
| Kbscase_Id | String | False |
Related case |
| Kbscase_Name | String | True | |
| Language | String | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Notuseful | Int | True | |
| Related_Languages | String | False | |
| Revision | Int | True | |
| Status | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Useful | Int | True | |
| Usefulness_User_Vote | String | True | |
| Viewcount | Int | True |
The KBContentTemplates table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Body | String | True |
Template body |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The KBDocuments table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The Leads table.
| Name | Type | ReadOnly | Description |
| Accept_Status_Calls | String | False | |
| Accept_Status_Id | String | False | |
| Accept_Status_Meetings | String | False | |
| Accept_Status_Messages | String | False | |
| Accept_Status_Name | String | False | |
| Account_Description | String | False |
Description of lead account |
| Account_Id | String | False |
If converted, Account ID resulting from the conversion |
| Account_Name | String | False |
Account name for lead |
| Account_To_Lead | String | True | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Ai_Conv_Bin_Accuracy | Decimal | True | |
| Ai_Conv_Multiplier | Decimal | True | |
| Ai_Conv_Score_Absolute | Decimal | True | |
| Ai_Conv_Score_Classification | String | True | |
| Ai_Icp_Fit_Bin_Accuracy | Decimal | True | |
| Ai_Icp_Fit_Multiplier | Decimal | True | |
| Ai_Icp_Fit_Score_Absolute | Decimal | True | |
| Ai_Icp_Fit_Score_Classification | String | True | |
| Alt_Address_City | String | False |
City for alternate address |
| Alt_Address_Country | String | False |
Country for alternate address |
| Alt_Address_Postalcode | String | False |
Postal code for alternate address |
| Alt_Address_State | String | False |
State for alternate address |
| Alt_Address_Street | String | False |
Street address for alternate address |
| Alt_Address_Street_2 | String | False | |
| Alt_Address_Street_3 | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Assistant | String | False |
Name of the assistant of the contact |
| Assistant_Phone | String | False |
Phone number of the assistant of the contact |
| Base_Rate | Decimal | False | |
| Birthdate | Date | False |
The birthdate of the contact |
| Brand_C | String | False | |
| Business_Center_Id | String | False |
The business center to which the case is associated |
| Business_Center_Name | String | True |
The name of the business center represented by the business_center_id field |
| C_Accept_Status_Fields | String | True | |
| Campaign_Id | String | False |
Campaign that generated lead |
| Campaign_Name | String | True | |
| Classification_C | String | False | |
| Commentlog | String | True | |
| Contact_Id | String | False |
If converted, Contact ID resulting from the conversion |
| Contact_Name | String | True | |
| Converted | Bool | False |
Has Lead been converted to a Contact (and other Sugar objects) |
| Converted_Opp_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Dead_End_Other_C | String | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Department | String | False |
Department the lead belongs to |
| Description | String | False |
Full text of the note |
| Dnb_Principal_Id | String | False |
Unique Id For DB Contact |
| Do_Not_Call | Bool | False |
An indicator of whether contact can be called |
| Dp_Business_Purpose | String | True |
Business purposes consented for |
| Dp_Consent_Last_Updated | Date | False |
Date consent last updated |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | True | |
| String | False | ||
| Email_Addresses_Non_Primary | String | False | |
| Email_Opt_Out | Bool | False | |
| Email1 | String | False | |
| Email2 | String | False | |
| Estimate_Remittance_C | Decimal | False | |
| String | False |
The facebook name of the user | |
| First_Name | String | False |
First name of the contact |
| Following | Bool | False |
Is user following this record |
| Full_Name | String | True | |
| Googleplus | String | False |
The google plus id of the user |
| Hint_Account_Annual_Revenue | String | False |
Annual Rev |
| Hint_Account_Description | String | False |
Company Description |
| Hint_Account_Facebook_Handle | String | False |
company facebook |
| Hint_Account_Fiscal_Year_End | String | False |
FY End |
| Hint_Account_Founded_Year | String | False |
company founded year |
| Hint_Account_Industry | String | False |
Company Industry |
| Hint_Account_Location | String | False |
Company Location |
| Hint_Account_Logo | String | False |
company logo |
| Hint_Account_Naics_Code_Lbl | String | False |
NAICS Code |
| Hint_Account_Sic_Code_Label | String | False |
SIC Code |
| Hint_Account_Size | String | False |
Company Size |
| Hint_Account_Twitter_Handle | String | False |
company twitter |
| Hint_Account_Website | String | False |
company website |
| Hint_Contact_Pic | String | False |
Hint Contact logo |
| Hint_Education | String | False |
Education |
| Hint_Education_2 | String | False |
Education 2 |
| Hint_Facebook | String | False | |
| Hint_Industry_Tags | String | False |
industry tags |
| Hint_Job_2 | String | False |
Job 2 |
| Hint_Phone_1 | String | False |
extra phone field |
| Hint_Phone_2 | String | False |
extra phone field |
| Hint_Photo | String | False |
person photo |
| Hint_Twitter | String | False | |
| Id [KEY] | String | True |
Unique identifier |
| Invalid_Email | Bool | False | |
| Last_Name | String | False |
Last name of the contact |
| Lead_Source | String | False |
Lead source (ex: Web, print) |
| Lead_Source_Description | String | False |
Description of the lead source |
| Locked_Fields | String | True | |
| M_Accept_Status_Fields | String | True | |
| Market_Interest_Prediction_Score | String | True | |
| Market_Score | Int | True | |
| Mkto_Id | Int | True |
Associated Marketo Lead ID |
| Mkto_Lead_Score | Int | True | |
| Mkto_Sync | Bool | False |
Should the Lead be synced to Marketo |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | True | |
| Opportunity_Amount | String | False |
Amount of the opportunity |
| Opportunity_Id | String | False |
If converted, Opportunity ID resulting from the conversion |
| Opportunity_Name | String | False |
Opportunity name associated with lead |
| Other_Underwriter_Notes_C | String | False | |
| Perform_Sugar_Action | Bool | False | |
| Phone_Fax | String | False |
Contact fax number |
| Phone_Home | String | False |
Home phone number of the contact |
| Phone_Mobile | String | False |
Mobile phone number of the contact |
| Phone_Other | String | False |
Other phone number for the contact |
| Phone_Work | String | False |
Work phone number of the contact |
| Picture | String | False |
Avatar |
| Portal_App | String | False |
Portal application that resulted in created of lead |
| Portal_Name | String | False |
Portal user name when lead created via lead portal |
| Preferred_Language | String | False | |
| Primary_Address_City | String | False |
City for primary address |
| Primary_Address_Country | String | False |
Country for primary address |
| Primary_Address_Postalcode | String | False |
Postal code for primary address |
| Primary_Address_State | String | False |
State for primary address |
| Primary_Address_Street | String | False |
The street address used for primary address |
| Primary_Address_Street_2 | String | False | |
| Primary_Address_Street_3 | String | False | |
| Refered_By | String | False |
Identifies who refered the lead |
| Report_To_Name | String | True | |
| Reports_To_Id | String | False |
ID of Contact the Lead reports to |
| Salutation | String | False |
Contact salutation (e.g., Mr, Ms) |
| Status | String | False |
Status of the lead |
| Status_Description | String | False |
Description of the status of the lead |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Title | String | False |
The title of the contact |
| String | False |
The twitter name of the user | |
| Underwriters_Non_Fntg_C | String | False | |
| Website | String | False |
URL of website for the company |
| Webtolead_Email_Opt_Out | Bool | False |
Indicator signaling if lead elects to opt out of email campaigns |
| Webtolead_Email1 | String | False |
Main email address of lead |
| Webtolead_Email2 | String | False |
Secondary email address of lead |
| Webtolead_Invalid_Email | Bool | False |
Indicator that email address for lead is invalid |
The Manufacturers table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| List_Order | Int | True |
Order within list |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Status | String | False |
Manufacturer status |
| Sync_Key | String | True | |
| Tag | String | False |
The Meetings table.
| Name | Type | ReadOnly | Description |
| Accept_Status | String | False | |
| Accept_Status_Users | String | False | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Auto_Invite_Parent | Bool | False |
Flag to allow for turning off auto invite of parent record - (Meta-data only) |
| Base_Rate | Decimal | False | |
| Cj_Activity_Tpl_Name | String | True | |
| Cj_Actual_Sort_Order | String | False | |
| Cj_Allow_Activity_By | String | False | |
| Cj_Blocked_By_Stages | String | False | |
| Cj_Momentum_End_Date | Datetime | False | |
| Cj_Momentum_Points | Int | True | |
| Cj_Momentum_Ratio | Double | True | |
| Cj_Momentum_Score | Int | True | |
| Cj_Momentum_Start_Date | Datetime | False | |
| Cj_Parent_Activity_Id | String | False | |
| Cj_Parent_Activity_Type | String | False | |
| Cj_Url | String | False | |
| Commentlog | String | True | |
| Contact_Id | String | True | |
| Contact_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Creator | String | False |
Meeting creator |
| Currency_Id | String | False | |
| Customer_Journey_Blocked_By | String | False | |
| Customer_Journey_Points | String | False | |
| Customer_Journey_Progress | Double | True | |
| Customer_Journey_Score | Int | True | |
| Date_End | Datetime | True |
Date meeting ends |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Start | Datetime | False |
Date of start of meeting |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Differentiating_Value_C | String | False | |
| Direction | String | False |
Indicates whether call is inbound or outbound |
| Displayed_Url | String | False |
Meeting URL |
| Dri_Subworkflow_Id | String | False | |
| Dri_Subworkflow_Name | String | True | |
| Dri_Subworkflow_Template_Id | String | False | |
| Dri_Subworkflow_Template_Name | String | True | |
| Dri_Workflow_Id | String | False | |
| Dri_Workflow_Name | String | True | |
| Dri_Workflow_Sort_Order | String | False | |
| Dri_Workflow_Task_Template_Id | String | False | |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | True | |
| Duration_Hours | Int | False |
Duration (hours) |
| Duration_Minutes | String | False |
Duration (minutes) |
| Email_Reminder_Checked | Bool | False |
checkbox indicating whether or not the email reminder value is set (Meta-data only) |
| Email_Reminder_Sent | Bool | False |
Whether email reminder is already sent |
| Email_Reminder_Time | String | False |
Specifies when a email reminder alert should be issued; -1 means no alert; otherwise the number of seconds prior to the start |
| Expense_To_Operation_C | Decimal | False | |
| External_Id | String | False |
Meeting ID for external app API |
| Fnf_Agencies_Meetings_1_Name | String | True | |
| Fnf_Agencies_Meetings_1fnf_Agencies_Ida | String | False | |
| Following | Bool | False |
Is user following this record |
| Host_Url | String | False |
Host URL |
| Id [KEY] | String | True |
Unique identifier |
| Internal_Notes | String | False |
Internal notes for the meeting |
| Invitees | String | True | |
| Is_Cj_Parent_Activity | Bool | False | |
| Is_Customer_Journey_Activity | Bool | False | |
| Join_Url | String | False |
Join URL |
| Location | String | False |
Meeting location |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Meeting name |
| Outlook_Id | String | False |
When the Sugar Plug-in for Microsoft Outlook syncs an Outlook appointment, this is the Outlook appointment item ID |
| Parent_Id | String | False |
ID of item indicated by parent_type |
| Parent_Name | String | True | |
| Parent_Type | String | True |
Module meeting is associated with |
| Password | String | False |
Meeting password |
| Recurrence_Id | Datetime | False |
Recurrence ID of meeting. Original meeting start date |
| Recurring_Source | String | False |
Source of recurring meeting |
| Reminder_Checked | Bool | False |
checkbox indicating whether or not the reminder value is set (Meta-data only) |
| Reminder_Time | String | False |
Specifies when a reminder alert should be issued; -1 means no alert; otherwise the number of seconds prior to the start |
| Repeat_Count | Int | True |
Number of recurrence |
| Repeat_Days | String | False |
Days of month |
| Repeat_Dow | String | False |
Days of week in recurrence |
| Repeat_Interval | Int | True |
Interval of recurrence |
| Repeat_Ordinal | String | False |
Repeat ordinal value |
| Repeat_Parent_Id | String | False |
Id of the first element of recurring records |
| Repeat_Selector | String | False |
Repeat selector |
| Repeat_Type | String | False |
Type of recurrence |
| Repeat_Unit | String | False |
Repeat unit value |
| Repeat_Until | Date | False |
Repeat until specified date |
| Send_Invites | Bool | False |
checkbox indicating whether or not to send out invites (Meta-data only) |
| Sequence | Int | True |
Meeting update sequence for meetings as per iCalendar standards |
| Set_Accept_Links | String | False | |
| Start_Next_Journey_Id | String | False | |
| Status | String | False |
Meeting status (ex: Planned, Held, Not held) |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Type | String | False |
Meeting type (ex: WebEx, Other) |
| Type_Of_Meeting_C | String | False |
The Messages table.
| Name | Type | ReadOnly | Description |
| Accept_Status | String | False | |
| Accept_Status_Users | String | False | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Aws_Comprehend_Data | String | False |
Raw data from the aws comprehend service |
| Aws_Contact_Id | String | True |
The AWS Connect Contact ID |
| Channel_Type | String | False | |
| Commentlog | String | True | |
| Contact_Id | String | False | |
| Contact_Name | String | True | |
| Conversation | String | True | |
| Conversation_Link | String | False | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_End | Datetime | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Start | Datetime | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Direction | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Invitee_Contact_Id | String | True | |
| Invitee_Contact_Name | String | True | |
| Invitee_Lead_Id | String | True | |
| Invitee_Lead_Name | String | True | |
| Invitees | String | True | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Parent_Id | String | False |
The ID of the Sugar item specified in parent_type |
| Parent_Name | String | True | |
| Parent_Type | String | True |
Sugar module the Message is associated with |
| Sentiment | String | False |
The sentiment string value (e.g POSITIVE, NEGATIVE, NEUTRAL, MIXED) |
| Status | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Sentiment | String | False |
The sentiment string value (e.g POSITIVE, NEGATIVE, NEUTRAL, MIXED) |
The Metrics table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Filter_Def | String | False | |
| Following | Bool | False |
Is user following this record |
| Freeze_First_Column | Bool | False |
Decides if the first column should be frozen |
| Id [KEY] | String | True |
Unique identifier |
| Labels | String | False | |
| Metric_Context | String | False | |
| Metric_Module | String | False | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Order_By_Primary | String | False | |
| Order_By_Primary_Direction | String | False | |
| Order_By_Secondary | String | False | |
| Order_By_Secondary_Direction | String | False | |
| Status | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Viewdefs | String | False |
The MobileDevices table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Device_Id | String | False | |
| Device_Platform | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True |
The Notes table.
| Name | Type | ReadOnly | Description |
| Acase_Id | String | False | |
| Account_Id | String | False | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Attachment_Flag | Bool | True |
Identify this note as an attachment to another record |
| Attachment_List | String | True | |
| Base_Rate | Decimal | False | |
| Commentlog | String | True | |
| Contact_Email | String | False | |
| Contact_Id | String | False |
Contact ID note is associated with |
| Contact_Name | String | True | |
| Contact_Phone | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Email_Id | String | False |
Email or EmailTemplate ID to which this note is attached |
| Email_Type | String | False |
The module of the record to which this note's file is attached (Emails or EmailTemplates) |
| Embed_Flag | Bool | False |
Embed flag indicator determines if note embedded in email |
| Entry_Source | String | True |
Determines if a record was created internal to the system or external to the system |
| Expense_To_Operation_C | Decimal | False | |
| External_Id | String | False |
External id of the external user |
| File_Ext | String | False | |
| File_Mime_Type | String | False |
Attachment MIME type |
| File_Size | Int | True |
Attachment File Size |
| File_Source | String | False |
The name of the module where the attachment originated |
| File_Url | String | False |
Path to file (can be URL) |
| Filename | String | True |
File name associated with the note (attachment) |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Lead_Id | String | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Name of the note |
| Note_Parent_Id | String | False |
The parent Note ID |
| Opportunity_Id | String | False | |
| Parent_Id | String | False |
The ID of the Sugar item specified in parent_type |
| Parent_Name | String | True | |
| Parent_Type | String | True |
Sugar module the Note is associated with |
| Portal_Flag | Bool | False |
Portal flag indicator determines if note created via portal |
| Product_Id | String | False | |
| Quote_Id | String | False | |
| Source_Id | String | False | |
| Source_Meta | String | False | |
| Source_Type | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Upload_Id | String | False |
File id under uploads/ dir. Set only for email attachments |
| User_Name | String | True |
The Notifications table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | True |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Is_Read | Bool | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Parent_Id | String | False |
ID of item indicated by parent_type. |
| Parent_Name | String | True | |
| Parent_Type | String | True |
Module notification is associated with. |
| Severity | String | False | |
| Sync_Key | String | True |
The OAuthKeys table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| C_Key | String | False |
Consumer public key |
| C_Secret | String | False |
Consumer secret key |
| Client_Type | String | False |
What type of client does this key belong to, mobile, portal, UI or other. |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Oauth_Type | String | False |
Is this client an OAuth1 or OAuth2 client |
| Sync_Key | String | True |
The OAuthTokens table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Callback_Url | String | False |
Callback URL for Authorization |
| Consumer | String | False |
Token related to the consumer |
| Consumer_Name | String | True | |
| Contact_Id | String | False |
Contact ID this oauth token is associated with (via portal) |
| Contact_Name | String | True | |
| Deleted | Bool | False |
Record deletion indicator |
| Download_Token | String | False |
A token used to download images and files. |
| Expire_Ts | String | False |
Token expiration, defaults to -1 for no expiration date |
| Id [KEY] | String | True |
Unique identifier |
| Platform | String | False |
Which platform is this token attached to |
| Secret | String | False |
Secret key |
| Token_Ts | String | False |
Token timestamp |
| Tstate | String | False |
Token state |
| Verify | String | False |
Token verification info |
The Opportunities table.
| Name | Type | ReadOnly | Description |
| Account_Id | String | False | |
| Account_Name | String | False | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Ai_Opp_Close_Week_Scores | String | True | |
| Ai_Opp_Conv_Bin_Accuracy | Decimal | True | |
| Ai_Opp_Conv_Multiplier | Decimal | True | |
| Ai_Opp_Conv_Score_Absolute | Decimal | True | |
| Ai_Opp_Conv_Score_Enum | String | True | |
| Amount | Decimal | True |
Unconverted amount of the opportunity |
| Amount_Usdollar | Decimal | True |
Formatted amount of the opportunity |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | True | |
| Best_Case | Decimal | True | |
| Campaign_Id | String | False |
Campaign that generated lead |
| Campaign_Name | String | True | |
| Closed_Revenue_Line_Items | Int | True | |
| Closed_Won_Revenue_Line_Items | Int | True | |
| Commentlog | String | True | |
| Commit_Stage | String | False |
Forecast commit ranges: Include, Likely, Omit etc. |
| Commit_Stage_Cascade | String | False | |
| Contact_Role | String | False | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Closed | Date | False |
Expected or actual date the oppportunity will close |
| Date_Closed_Cascade | Date | False | |
| Date_Closed_Timestamp | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | True | |
| Following | Bool | False |
Is user following this record |
| Forecasted_Likely | Decimal | True |
Rollup of included RLIs on the Opportunity |
| Id [KEY] | String | True |
Unique identifier |
| Included_Revenue_Line_Items | Int | True | |
| Is_Escalated | Bool | True |
Is this escalated? |
| Lead_Source | String | False |
Source of the opportunity |
| Locked_Fields | String | True | |
| Lost | Decimal | True |
Rollup of lost RLIs on the Opportunity |
| Mkto_Id | Int | True |
Associated Marketo Lead ID |
| Mkto_Sync | Bool | False |
Should the Lead be synced to Marketo |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Name of the opportunity |
| Next_Step | String | False |
The next step in the sales process |
| Opportunity_Type | String | False |
Type of opportunity (ex: Existing, New) |
| Perform_Sugar_Action | Bool | False | |
| Probability | Int | True |
The probability of closure |
| Renewal | Bool | False |
Indicates whether the opportunity is a renewal |
| Renewal_Parent_Id | String | False | |
| Renewal_Parent_Name | String | True | |
| Sales_Stage | String | False |
Indication of progression towards closure |
| Sales_Stage_Cascade | String | False | |
| Sales_Status | String | True | |
| Service_Duration_Unit | String | False |
Service duration unit: day, month, or year |
| Service_Duration_Unit_Cascade | String | False | |
| Service_Duration_Value | Int | True |
Value of the service duration, if service duration is 4 Months the value is 4 |
| Service_Duration_Value_Cascade | Int | True | |
| Service_Open_Flex_Duration_Rlis | Int | True | |
| Service_Open_Revenue_Line_Items | Int | True | |
| Service_Start_Date | Date | False |
Service start date field. |
| Service_Start_Date_Cascade | Date | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Total_Revenue_Line_Items | Int | True | |
| Widget_Amount | String | True | |
| Widget_Date_Closed | String | True | |
| Widget_Sales_Stage | String | True | |
| Worst_Case | Decimal | True |
The OutboundEmail table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Authorized_Account | String | True | |
| Deleted | Bool | False | |
| Eapm_Id | String | True | |
| Email_Address | String | False | |
| Email_Address_Id | String | False | |
| Id [KEY] | String | True | |
| Mail_Authtype | String | True | |
| Mail_Sendtype | String | False | |
| Mail_Smtpauth_Req | Bool | False | |
| Mail_Smtppass | String | True | |
| Mail_Smtpport | Int | True | |
| Mail_Smtpserver | String | False | |
| Mail_Smtpssl | String | False | |
| Mail_Smtptype | String | False | |
| Mail_Smtpuser | String | False | |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Preferred_Sending_Account | Bool | False | |
| Reply_To_Email_Address | String | True | |
| Reply_To_Email_Address_Id | String | False | |
| Reply_To_Name | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Type | String | False | |
| User_Id | String | False |
The PdfManager table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Author | String | False | |
| Base_Module | String | False | |
| Body_Html | String | False | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Field | String | False | |
| Following | Bool | False |
Is user following this record |
| Footer_Text | String | False | |
| Header_Logo | String | True |
PDF header logo |
| Header_Text | String | False | |
| Header_Title | String | False | |
| Id [KEY] | String | True |
Unique identifier |
| Keywords | String | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Published | String | False | |
| Subject | String | False | |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Template_Name | String | False | |
| Title | String | False |
The pmse_Business_Rules table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Rst_Create_Date | Datetime | False | |
| Rst_Definition | String | False | |
| Rst_Editable | Int | True | |
| Rst_Filename | String | False | |
| Rst_Module | String | False | |
| Rst_Source | String | False | |
| Rst_Source_Definition | String | True | |
| Rst_Type | String | False | |
| Rst_Uid | String | False | |
| Rst_Update_Date | Datetime | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The pmse_Emails_Templates table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Module | String | False | |
| Body | String | False | |
| Body_Html | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| From_Address | String | False | |
| From_Name | String | False | |
| Id [KEY] | String | True |
Unique identifier |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Published | String | False | |
| Subject | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Text_Only | String | True | |
| Type | String | False |
The pmse_Inbox table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Act_Name | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Cas_Assigned_Status | String | False | |
| Cas_Create_Date | Datetime | False | |
| Cas_Custom_Status | String | False | |
| Cas_Finish_Date | Datetime | False | |
| Cas_Id | Int | False | |
| Cas_Init_User | String | False | |
| Cas_Module | String | False | |
| Cas_Parent | Int | False | |
| Cas_Pin | String | False | |
| Cas_Status | String | False | |
| Cas_Title | String | False | |
| Cas_Update_Date | Datetime | False | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Pro_Id | String | False | |
| Pro_Title | String | False | |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The pmse_Project table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Prj_Author | String | False | |
| Prj_Author_Version | String | False | |
| Prj_Exporter | String | False | |
| Prj_Exporter_Version | String | False | |
| Prj_Expression_Language | String | False | |
| Prj_Module | String | False | |
| Prj_Original_Source | String | False | |
| Prj_Run_Order | Int | True | |
| Prj_Status | String | False |
Process Definition status (ex: Enabled, Disabled) |
| Prj_Target_Namespace | String | False | |
| Prj_Type_Language | String | False | |
| Prj_Uid | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The ProductBundleNotes table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True |
User who created record |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | True |
Note content |
| Id [KEY] | String | True |
Unique identifier |
| Modified_User_Id | String | True |
User who last modified record |
| Position | Int | True |
The ProductBundles table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Base_Rate | String | False | |
| Bundle_Stage | String | False |
Processing stage of the group (ex: Draft) |
| Created_By | String | True |
User who created record |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deal_Tot | Decimal | True |
discount amount |
| Deal_Tot_Usdollar | Decimal | True |
discount amount |
| Default_Group | Bool | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Group description |
| Id [KEY] | String | True |
Unique identifier |
| Modified_User_Id | String | True |
User who last modified record |
| Name | String | False |
Name of the group |
| New_Sub | Decimal | True |
Group total minus discount and tax and shipping |
| New_Sub_Usdollar | Decimal | True |
Group total minus discount and tax and shipping |
| Position | Int | True | |
| Product_Bundle_Items | String | True | |
| Shipping | Decimal | True |
Shipping charge for group |
| Shipping_Usdollar | Decimal | True |
Shipping charge for group in USD |
| Subtotal | Decimal | True |
Group total minus tax and shipping |
| Subtotal_Usdollar | Decimal | True |
Group total minus tax and shipping in USD |
| Sync_Key | String | True | |
| Tax | Decimal | True |
Tax rate applied to items in the group |
| Tax_Usdollar | Decimal | True |
Total tax for all items in group in USD |
| Taxable_Subtotal | Decimal | True |
Rollup of all products marked as Taxable |
| Taxrate_Id | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Total | Decimal | True |
Total amount for all items in the group |
| Total_Usdollar | Decimal | True |
Total amount for all items in the group in USD |
The ProductCategories table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| List_Order | Int | True |
Order within list |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Parent_Id | String | False |
Parent category of this item; used for multi-tiered categorization |
| Parent_Name | String | True | |
| Sync_Key | String | True | |
| Type | String | False |
The Products table.
| Name | Type | ReadOnly | Description |
| Account_Id | String | True |
Account this product is associated with |
| Account_Name | String | True | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Add_On_To_Id | String | False |
Purchased line item that this is an add-on to |
| Add_On_To_Name | String | True | |
| Asset_Number | String | False |
Asset tag number of sales item in use |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Book_Value | Decimal | True |
Book value of sales item in use |
| Book_Value_Date | Date | False |
Date of book value for sales item in use |
| Book_Value_Usdollar | Decimal | True |
Book value expressed in USD |
| Campaign_Id | String | False |
Campaign that generated lead |
| Campaign_Name | String | True | |
| Catalog_Service_Duration_Unit | String | True |
Stores a Product Catalog item's Service Duration Unit, used for duration comparisons |
| Catalog_Service_Duration_Value | Int | True |
Stores a Product Catalog item's Service Duration Value, used for duration comparisons |
| Category_Id | String | False |
Product category |
| Category_Name | String | True | |
| Commentlog | String | True | |
| Contact_Id | String | False |
Contact this product is associated with |
| Contact_Name | String | True | |
| Cost_Price | Decimal | True |
Product cost ( |
| Cost_Usdollar | Decimal | True |
Cost expressed in USD |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Closed | Date | False |
Expected or actual date the product (for opportunity) will close |
| Date_Closed_Timestamp | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Purchased | Date | False |
Date sales item purchased |
| Date_Support_Expires | Date | False |
Support expiration date |
| Date_Support_Starts | Date | False |
Support start date |
| Deal_Calc | Decimal | True |
deal_calc |
| Deal_Calc_Usdollar | Decimal | True |
deal_calc_usdollar |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Discount_Amount | String | True |
Discounted amount |
| Discount_Amount_Signed | Decimal | True |
Discounted Amount Signed |
| Discount_Amount_Usdollar | Decimal | True | |
| Discount_Price | Decimal | True |
Discounted price ( |
| Discount_Rate_Percent | Decimal | True | |
| Discount_Select | Bool | False | |
| Discount_Usdollar | Decimal | True |
Discount price expressed in USD |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| List_Price | Decimal | True |
List price of sales item |
| List_Usdollar | Decimal | True |
List price expressed in USD |
| Lock_Duration | Bool | False |
Turn on or off a user ability to directly edit the duration field |
| Locked_Fields | String | True | |
| Manufacturer_Id | String | False |
Manufacturer of product |
| Manufacturer_Name | String | True | |
| Mft_Part_Num | String | False |
Manufacturer part number |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Name of the product |
| Next_Step | String | False |
The next step in the sales process |
| Opportunity_Id | String | False |
The opportunity id for the line item entry |
| Opportunity_Name | String | True |
The opportunity name associated with the opportunity_id |
| Parent_Rli_Id | String | False |
RLI this product was generated from |
| Parent_Rli_Name | String | True | |
| Position | Int | True | |
| Pricing_Factor | Int | True |
Variable pricing factor depending on pricing_formula |
| Pricing_Formula | String | False |
Pricing formula (ex: Fixed, Markup over Cost) |
| Product_Template_Id | String | False |
Product (in Admin Products) from which this product is derived (in user Products) |
| Product_Template_Name | String | True | |
| Quantity | Decimal | True |
Quantity in use |
| Quote_Id | String | False |
If product created via Quote, this is quote ID |
| Quote_Name | String | True |
Quote Name |
| Renewable | Bool | False |
Indicates whether the sales item is renewable (e.g. a service) |
| Renewal | Bool | True |
Indicates whether this line item is a renewal |
| Revenuelineitem_Id | String | False |
Associated Revenue Line Item that served as the source. |
| Revenuelineitem_Name | String | True | |
| Serial_Number | String | False |
Serial number of sales item in use |
| Service | Bool | False |
Indicates whether the sales item is a service or a product |
| Service_Duration_Multiplier | Decimal | True |
Stores a multiplier based on the ratio of this sales item's duration to another duration (such as a Product Template's) |
| Service_Duration_Unit | String | False |
Service Duration unit like Year(s), Month(s) or Day(s) |
| Service_Duration_Value | Int | True |
Value of the service duration, if service duration is 4 Months the value is 4 |
| Service_End_Date | String | True |
End date of the service |
| Service_Start_Date | Date | False |
Start date of the service |
| Status | String | False |
Product status (ex: Quoted, Ordered, Shipped) |
| Subtotal | Decimal | True |
The total of the line item before any discounts are applied, taking proration into consideration |
| Support_Contact | String | False |
Contact for support purposes |
| Support_Description | String | False |
Description of sales item for support purposes |
| Support_Name | String | False |
Name of sales item for support purposes |
| Support_Term | String | False |
Term (length) of support contract |
| Sync_Key | String | True | |
| Tag | String | False | |
| Tax_Class | String | False |
Tax classification (ex: Taxable, Non-taxable) |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Total_Amount | Decimal | True | |
| Type_Id | String | False |
Product type (ex: hardware, software) |
| Type_Name | String | True | |
| Vendor_Part_Num | String | False |
Vendor part number |
| Website | String | False |
Sales item URL |
| Weight | Decimal | True |
Weight of the sales item |
The ProductTemplates table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Active_Status | String | False |
Active status (ex: Active, Inactive or Retired) |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Category_Id | String | False |
Category of the product |
| Category_Name | String | True | |
| Commentlog | String | True | |
| Cost_Price | Decimal | False |
Product cost ( |
| Cost_Usdollar | Decimal | True |
Cost expressed in USD |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Available | Date | False |
Availability date |
| Date_Cost_Price | Date | False |
Starting date cost price is valid |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Discount_Price | Decimal | False |
Discounted price ( |
| Discount_Usdollar | Decimal | True |
Discount price expressed in USD |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| List_Price | Decimal | False |
List price of product ( |
| List_Usdollar | Decimal | True |
List price expressed in USD |
| Lock_Duration | Bool | False |
Indicates whether the duration can be manually changed |
| Locked_Fields | String | True | |
| Manufacturer_Id | String | False |
Manufacturer of the product |
| Manufacturer_Name | String | True | |
| Mft_Part_Num | String | False |
Manufacturer part number |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Pricing_Factor | Decimal | True |
Variable pricing factor depending on pricing_formula |
| Pricing_Formula | String | True |
Pricing formula (ex: Fixed, Markup over Cost) |
| Qty_In_Stock | Int | True |
Quantity on hand |
| Renewable | Bool | False |
Indicates whether the sales item is renewable (e.g. a service) |
| Service | Bool | False |
Indicates whether the sales item is a service or a product |
| Service_Duration_Unit | String | False |
Service Duration unit like Year(s), Month(s) or Day(s) |
| Service_Duration_Value | Int | True |
Value of the service duration, if service duration is 4 Months the value is 4 |
| Status | String | False |
Product status (not used in product Catalog) |
| Support_Contact | String | False |
Contact for support purposes |
| Support_Description | String | False |
Description of product for support purposes |
| Support_Name | String | False |
Name of product for support purposes |
| Support_Term | String | False |
Term (length) of support contract |
| Sync_Key | String | True | |
| Tag | String | False | |
| Tax_Class | String | False |
Tax classification (ex: Taxable, Non-taxable) |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Type_Id | String | False |
Product type (ex: hardware, software) |
| Type_Name | String | True | |
| Vendor_Part_Num | String | False |
Vendor part number |
| Website | String | False |
Product URL |
| Weight | Decimal | True |
Weight of the product |
The ProductTypes table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Product type description |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| List_Order | Int | False |
Order within list |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Tag | String | False |
The Project table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User assigned to this record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Project description |
| Estimated_End_Date | Date | False | |
| Estimated_Start_Date | Date | False | |
| Id [KEY] | String | True |
Unique identifier |
| Is_Template | Bool | False |
Should be checked if the project is a template |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| Name | String | False |
Project name |
| Priority | String | False | |
| Status | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Total_Actual_Effort | Int | True | |
| Total_Estimated_Effort | Int | True |
The ProjectTask table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Actual_Duration | Int | True | |
| Actual_Effort | Int | True | |
| Assigned_User_Id | String | False | |
| Assigned_User_Name | String | True | |
| Created_By | String | True | |
| Created_By_Name | String | True | |
| Date_Due | Date | False | |
| Date_Entered | Datetime | True | |
| Date_Finish | Date | False | |
| Date_Modified | Datetime | True | |
| Date_Start | Date | False | |
| Deleted | Bool | False | |
| Description | String | False | |
| Duration | Int | False | |
| Duration_Unit | String | False | |
| Estimated_Effort | Int | True | |
| Id [KEY] | String | True | |
| Milestone_Flag | Bool | False | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True | |
| Name | String | False | |
| Order_Number | Int | True | |
| Parent_Task_Id | Int | True | |
| Percent_Complete | Int | True | |
| Predecessors | String | False | |
| Priority | String | False | |
| Project_Id | String | False | |
| Project_Name | String | True | |
| Project_Task_Id | Int | True | |
| Resource_Id | String | False | |
| Resource_Name | String | False | |
| Status | String | False | |
| Task_Number | Int | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Time_Due | String | True | |
| Time_Finish | Int | True | |
| Time_Start | Int | True | |
| Utilization | Int | True |
The ProspectLists table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True | |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| Description | String | False | |
| Domain_Name | String | False | |
| Entry_Count | Int | True | |
| Id [KEY] | String | True | |
| List_Type | String | False | |
| Marketing_Id | String | False | |
| Marketing_Name | String | False | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True | |
| Name | String | False | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The PubSub_ModuleEvent_PushSubs table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Expiration_Date | Datetime | False |
Subscriptions last 7 days and must be updated to be extended |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Target_Module | String | False |
Send notifications regarding this module |
| Token | String | False |
An arbitrary string delivered to the destination with each notification |
| Webhook_Url | String | False |
Send notifications to this webhook |
The PurchasedLineItems table.
| Name | Type | ReadOnly | Description |
| Account_Id | String | False |
Account related to the parent Purchase of this PLI |
| Account_Name | String | True | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Annual_Revenue | Decimal | True | |
| Asset_Number | String | False |
Asset tag number of sales item in use |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Book_Value | Decimal | True |
Book value of sales item in use |
| Book_Value_Date | Date | False |
Date of book value for sales item in use |
| Book_Value_Usdollar | Decimal | True |
Book value expressed in USD |
| Catalog_Service_Duration_Unit | String | True |
Stores a Product Catalog item's Service Duration Unit, used for duration comparisons |
| Catalog_Service_Duration_Value | Int | True |
Stores a Product Catalog item's Service Duration Value, used for duration comparisons |
| Category_Id | String | False |
Product category |
| Category_Name | String | True | |
| Commentlog | String | True | |
| Cost_Price | Decimal | True |
Product cost |
| Cost_Usdollar | Decimal | True |
Cost expressed in USD |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Closed | Date | False |
Expected or actual date the purchased line item will close |
| Date_Closed_Timestamp | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Purchased | Date | False |
Date sales item purchased |
| Date_Support_Expires | Date | False |
Support expiration date |
| Date_Support_Starts | Date | False |
Support start date |
| Deal_Calc | Decimal | True |
Calculated Revenue or Loss |
| Deal_Calc_Usdollar | Decimal | True |
Calculated Revenue or Loss in US Dollars |
| Deleted | Bool | False |
Record deletion indicator |
| Denorm_Account_Name | String | False |
Name of the Company |
| Description | String | False |
Full text of the note |
| Discount_Amount | String | True |
Discounted amount (Displayed as Total Discount Amount) |
| Discount_Amount_Signed | Decimal | True |
Discounted Amount Signed |
| Discount_Amount_Usdollar | Decimal | True | |
| Discount_Price | Decimal | False |
Discounted price ( |
| Discount_Select | Bool | False | |
| Discount_Usdollar | Decimal | True |
Discount price expressed in USD |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| List_Price | Decimal | True |
List price of sales item |
| List_Usdollar | Decimal | True |
List price expressed in USD |
| Lock_Duration | Bool | False |
Turn on or off a user ability to directly edit the duration field |
| Locked_Fields | String | True | |
| Manufacturer_Id | String | False |
Manufacturer of product |
| Manufacturer_Name | String | True | |
| Mft_Part_Num | String | False |
Manufacturer part number |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Name of the product |
| Pricing_Factor | Int | True |
Variable pricing factor depending on pricing_formula |
| Pricing_Formula | String | False |
Pricing formula (ex: Fixed, Markup over Cost) |
| Product_Template_Id | String | False |
Product (in Admin Products) from which this purchased item is derived. |
| Product_Template_Name | String | True | |
| Product_Type_Id | String | False |
Product type (ex: hardware, software) |
| Product_Type_Name | String | True | |
| Purchase_Id | String | False |
Purchase which spawned this PLI |
| Purchase_Name | String | False | |
| Quantity | Decimal | True |
Quantity in use |
| Renewable | Bool | False |
Indicates whether the sales item is renewable (e.g. a service) |
| Renewal | Bool | True |
Indicates whether this line item is a renewal |
| Renewal_Opp_Id | String | False |
Renewal opportunity of this PLI |
| Renewal_Opp_Name | String | True | |
| Revenue | Decimal | False | |
| Revenue_Usdollar | Decimal | True |
Revenue expressed in USD |
| Revenuelineitem_Id | String | False |
If PLI was created from RLI, this is that RLIs ID |
| Revenuelineitem_Name | String | True |
RLI Name |
| Serial_Number | String | False |
Serial number of sales item in use |
| Service | Bool | False |
Indicates whether the sales item is a service or a product |
| Service_Duration_Multiplier | Decimal | True |
Stores a multiplier based on the ratio of this sales item's duration to another duration (such as a Product Template's) |
| Service_Duration_Unit | String | False |
Service Duration unit like Year(s), Month(s) or Day(s) |
| Service_Duration_Value | Int | True |
Value of the service duration, if service duration is 4 Months the value is 4 |
| Service_End_Date | String | True |
End date of the service |
| Service_Start_Date | Date | False |
Start date of the service |
| Status | String | False | |
| Subtotal | Decimal | True |
The total of the line item before any discounts are applied, taking any proration into consideration |
| Support_Contact | String | False |
Contact for support purposes |
| Support_Description | String | False |
Description of sales item for support purposes |
| Support_Name | String | False |
Name of sales item for support purposes |
| Support_Term | String | False |
Term (length) of support contract |
| Sync_Key | String | True | |
| Tag | String | False | |
| Tax_Class | String | False |
Tax classification (ex: Taxable, Non-taxable) |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Total_Amount | Decimal | True | |
| Vendor_Part_Num | String | False |
Vendor part number |
| Website | String | False |
Sales item URL |
| Weight | Decimal | True |
Weight of the sales item |
The Purchases table.
| Name | Type | ReadOnly | Description |
| Account_Id | String | False | |
| Account_Name | String | False | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Category_Id | String | False |
Product category |
| Category_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| End_Date | Date | True |
End date of the purchase |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Pli_Collection | String | True | |
| Pli_Count | Int | True | |
| Product_Template_Id | String | False | |
| Product_Template_Name | String | True | |
| Renewable | Bool | False |
Indicates whether the purchase is renewable |
| Service | Bool | False |
Indicates whether the purchase is a service |
| Start_Date | Date | True |
Start date of the purchase |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Total_Quantity | Decimal | True | |
| Total_Revenue | Decimal | True | |
| Type_Id | String | False |
Product type (ex: hardware, software] |
| Type_Name | String | True |
The PushNotifications table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Extra_Data | String | False |
JSON encoded string containing extra data. |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Is_Sent | Bool | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Notification_Type | String | False |
Type of notification, eg, record_assignment. |
| Parent_Id | String | False |
ID of item indicated by parent_type. |
| Parent_Type | String | True |
Module notification is associated with. |
| Sync_Key | String | True |
The Quotas table.
| Name | Type | ReadOnly | Description |
| Amount | Decimal | False | |
| Amount_Base_Currency | Decimal | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Commentlog | String | True | |
| Committed | Bool | False | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Quota_Type | String | False | |
| Sync_Key | String | True | |
| Timeperiod_Id | String | False | |
| User_Full_Name | String | False | |
| User_Id | String | False | |
| User_Name | String | False |
The Quotes table.
| Name | Type | ReadOnly | Description |
| Account_Id | String | True | |
| Account_Name | String | True | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | False | |
| Billing_Account_Id | String | True | |
| Billing_Account_Name | String | False | |
| Billing_Address_City | String | False | |
| Billing_Address_Country | String | False | |
| Billing_Address_Postalcode | String | False | |
| Billing_Address_State | String | False | |
| Billing_Address_Street | String | False | |
| Billing_Contact_Id | String | True | |
| Billing_Contact_Name | String | True | |
| Bundles | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Order_Shipped | Date | False | |
| Date_Quote_Closed | Date | False | |
| Date_Quote_Expected_Closed | Date | False | |
| Deal_Tot | Decimal | True | |
| Deal_Tot_Discount_Percentage | Double | True | |
| Deal_Tot_Usdollar | Decimal | True | |
| Deleted | Bool | False |
Record deletion indicator |
| Denorm_Billing_Account_Name | String | False |
Name of the Company |
| Description | String | False |
Full text of the note |
| Discount | Decimal | True | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| New_Sub | Decimal | True | |
| New_Sub_Usdollar | Decimal | True | |
| Opportunity_Id | String | True | |
| Opportunity_Name | String | True | |
| Order_Stage | String | False | |
| Original_Po_Date | Date | False | |
| Payment_Terms | String | False | |
| Purchase_Order_Num | String | False | |
| Quote_Num | Int | False | |
| Quote_Stage | String | False | |
| Quote_Type | String | False | |
| Renewal | Bool | True |
Indicates whether this quote is a renewal |
| Shipper_Id | String | False | |
| Shipper_Name | String | True |
Shipper Name |
| Shipping | Decimal | True | |
| Shipping_Account_Id | String | True | |
| Shipping_Account_Name | String | True | |
| Shipping_Address_City | String | False | |
| Shipping_Address_Country | String | False | |
| Shipping_Address_Postalcode | String | False | |
| Shipping_Address_State | String | False | |
| Shipping_Address_Street | String | False | |
| Shipping_Contact_Id | String | True | |
| Shipping_Contact_Name | String | True | |
| Shipping_Usdollar | Decimal | True | |
| Show_Line_Nums | Bool | False | |
| Subtotal | Decimal | True | |
| Subtotal_Usdollar | Decimal | True | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Tax | Decimal | True | |
| Tax_Usdollar | Decimal | True | |
| Taxable_Subtotal | Decimal | True |
Rollup of product bundles taxable_subtotal values |
| Taxrate_Id | String | False | |
| Taxrate_Name | String | True |
Tax Rate Name |
| Taxrate_Value | Decimal | True |
Tax Rate Value |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Total | Decimal | True | |
| Total_Usdollar | Decimal | True |
The Releases table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| Id [KEY] | String | True | |
| List_Order | Int | True | |
| Modified_User_Id | String | True | |
| Name | String | False | |
| Status | String | False |
The ReportMaker table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Created_By | String | True | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| Description | String | False | |
| Id [KEY] | String | True | |
| Modified_User_Id | String | True | |
| Name | String | False | |
| Report_Align | String | False | |
| Scheduled | Bool | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Title | String | False |
The Reports table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Chart_Type | String | False | |
| Content | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Favorite | Bool | False | |
| Id [KEY] | String | True |
Unique identifier |
| Is_Published | Bool | False | |
| Last_Run_Date | Datetime | False | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| Module | String | False | |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Report_Cache_Id | String | False | |
| Report_Type | String | False | |
| Schedule_Type | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The ReportSchedules table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Active | Bool | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Start | Datetime | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Embed_Report | String | False |
Embed report in email |
| File_Type | String | False |
File type for scheduled report attachment |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Next_Run | Datetime | False | |
| Report_Id | String | False | |
| Report_Name | String | False | |
| Schedule_Type | String | False |
Legacy field. ent for advanced reports, pro for regular reports |
| Sync_Key | String | True | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Time_Interval | String | False | |
| User_Id | String | False |
The RevenueLineItems table.
| Name | Type | ReadOnly | Description |
| Account_Id | String | False |
Account this product is associated with |
| Account_Name | String | True | |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Add_On_To_Id | String | False |
Purchased line item that this is an add-on to |
| Add_On_To_Name | String | True | |
| Asset_Number | String | False |
Asset tag number of sales item in use |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Base_Rate | String | True | |
| Best_Case | Decimal | True | |
| Book_Value | Decimal | True |
Book value of sales item in use |
| Book_Value_Date | Date | False |
Date of book value for sales item in use |
| Book_Value_Usdollar | Decimal | True |
Book value expressed in USD |
| Campaign_Id | String | False |
Campaign that generated lead |
| Campaign_Name | String | True | |
| Catalog_Service_Duration_Unit | String | True |
Stores a Product Catalog item's Service Duration Unit, used for duration comparisons |
| Catalog_Service_Duration_Value | Int | True |
Stores a Product Catalog item's Service Duration Value, used for duration comparisons |
| Category_Id | String | False |
Product category |
| Category_Name | String | True | |
| Commentlog | String | True | |
| Commit_Stage | String | False |
Forecast commit category: Include, Likely, Omit etc. |
| Cost_Price | Decimal | True |
Product cost ( |
| Cost_Usdollar | Decimal | True |
Cost expressed in USD |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False | |
| Currency_Name | String | True | |
| Currency_Symbol | String | True | |
| Date_Closed | Date | False |
Expected or actual date the product (for opportunity) will close |
| Date_Closed_Timestamp | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Purchased | Date | False |
Date sales item purchased |
| Date_Support_Expires | Date | False |
Support expiration date |
| Date_Support_Starts | Date | False |
Support start date |
| Deal_Calc | Decimal | True |
deal_calc |
| Deal_Calc_Usdollar | Decimal | True |
deal_calc_usdollar |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Discount_Amount | String | True |
Discounted amount |
| Discount_Amount_Signed | Decimal | True |
Discounted Amount Signed |
| Discount_Amount_Usdollar | Decimal | True | |
| Discount_Price | Decimal | True |
Discounted price ( |
| Discount_Rate_Percent | Decimal | True | |
| Discount_Select | Bool | False | |
| Discount_Usdollar | Decimal | True |
Discount price expressed in USD |
| Following | Bool | False |
Is user following this record |
| Forecasted_Likely | Decimal | True |
Rollup of included RLIs on the Opportunity |
| Generate_Purchase | String | False |
Generate Purchase Options (ex: Yes, No, Completed) |
| Id [KEY] | String | True |
Unique identifier |
| Lead_Source | String | False |
Source of the product |
| Likely_Case | Decimal | False | |
| List_Price | Decimal | True |
List price of sales item |
| List_Usdollar | Decimal | True |
List price expressed in USD |
| Lock_Duration | Bool | False |
Turn on or off a user ability to directly edit the duration field |
| Locked_Fields | String | True | |
| Manufacturer_Id | String | False |
Manufacturer of product |
| Manufacturer_Name | String | True | |
| Mft_Part_Num | String | False |
Manufacturer part number |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Name of the product |
| Next_Step | String | False |
The next step in the sales process |
| Opportunity_Id | String | False |
The opportunity id for the line item entry |
| Opportunity_Name | String | False |
The opportunity name associated with the opportunity_id |
| Pricing_Factor | Int | True |
Variable pricing factor depending on pricing_formula |
| Pricing_Formula | String | False |
Pricing formula (ex: Fixed, Markup over Cost) |
| Probability | Int | True |
The probability of closure |
| Product_Template_Id | String | False |
Product (in Admin Products) from which this product is derived (in user Products) |
| Product_Template_Name | String | True | |
| Product_Type | String | False |
Type of product ( from opportunities opportunity_type ex: Existing, New) |
| Purchasedlineitem_Id | String | False |
If PLI was created from this RLI, this is that PLIs ID |
| Purchasedlineitem_Name | String | True |
PLI Name |
| Quantity | Decimal | True |
Quantity in use |
| Quote_Id | String | False |
If product created via Quote, this is quote ID |
| Quote_Name | String | True |
Quote Name |
| Renewable | Bool | False |
Indicates whether the sales item is renewable (e.g. a service) |
| Renewal | Bool | True |
Indicates whether this line item is a renewal |
| Renewal_Rli_Id | String | False |
Renewal RLI of this RLI, set during renewal generation |
| Renewal_Rli_Name | String | True | |
| Sales_Stage | String | False |
Indication of progression towards closure |
| Serial_Number | String | False |
Serial number of sales item in use |
| Service | Bool | False |
Indicates whether the sales item is a service or a product |
| Service_Duration_Multiplier | Decimal | True |
Stores a multiplier based on the ratio of this sales item's duration to another duration (such as a Product Template's) |
| Service_Duration_Unit | String | False |
Service Duration unit like Year(s), Month(s) or Day(s) |
| Service_Duration_Value | Int | True |
Value of the service duration, if service duration is 4 Months the value is 4 |
| Service_End_Date | String | True |
End date of the service |
| Service_Start_Date | Date | False |
Start date of the service |
| Status | String | False |
Product status (ex: Quoted, Ordered, Shipped) |
| Subtotal | Decimal | True |
Stores the total of the line item before any discounts are applied, taking proration into consideration |
| Support_Contact | String | False |
Contact for support purposes |
| Support_Description | String | False |
Description of sales item for support purposes |
| Support_Name | String | False |
Name of sales item for support purposes |
| Support_Term | String | False |
Term (length) of support contract |
| Sync_Key | String | True | |
| Tag | String | False | |
| Tax_Class | String | False |
Tax classification (ex: Taxable, Non-taxable) |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Total_Amount | Decimal | True | |
| Type_Id | String | False |
Product type (ex: hardware, software) |
| Type_Name | String | True | |
| Vendor_Part_Num | String | False |
Vendor part number |
| Website | String | False |
Sales item URL |
| Weight | Decimal | True |
Weight of the sales item |
| Worst_Case | Decimal | True |
The SavedSearch table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False | |
| Assigned_User_Name | String | False | |
| Contents | String | False | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| Description | String | False | |
| Id [KEY] | String | True | |
| Name | String | False | |
| Search_Module | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False |
The Schedulers table.
| Name | Type | ReadOnly | Description |
| Adv_Interval | Bool | False | |
| Catch_Up | Bool | False | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Time_End | Datetime | False | |
| Date_Time_Start | Datetime | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Job | String | False | |
| Job_Function | String | False | |
| Job_Interval | String | False | |
| Job_Url | String | False | |
| Last_Run | Datetime | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Status | String | False | |
| Sync_Key | String | True | |
| System_Job | Bool | False | |
| Time_From | String | True | |
| Time_To | String | True |
The ShiftExceptions table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| All_Day | Bool | False |
The Shift Exception is all day or not |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Enabled | Bool | False |
An indicator of whether shift exception is enabled |
| End_Date | Date | False |
The end date of the shift exception |
| End_Hour | String | False |
The hour portion of the time this shift exception ends |
| End_Minutes | String | False |
The minute portion of the time this shift exception ends |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Shift_Exception_Type | String | False |
The Shift Exception is of this type |
| Start_Date | Date | False |
The start date of the shift exception |
| Start_Hour | String | False |
The hour portion of the time this shift exception starts |
| Start_Minutes | String | False |
The minute portion of the time this shift exception starts |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Timezone | String | False |
Time Zone in which this Shift Exception operates |
The Shifts table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_End | Date | False |
Date is which shift is scheduled to (or did) end |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Start | Date | False |
Date in which shift is schedule to (or did) start |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Friday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Friday |
| Friday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Friday |
| Friday_Open_Hour | String | False |
The hour portion of the time this business center is open on Friday |
| Friday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Friday |
| Id [KEY] | String | True |
Unique identifier |
| Is_Open_Friday | Bool | False |
Explicit marker for if this business center is open on Friday |
| Is_Open_Monday | Bool | False |
Explicit marker for if this business center is open on Monday |
| Is_Open_Saturday | Bool | False |
Explicit marker for if this business center is open on Saturday |
| Is_Open_Sunday | Bool | False |
Explicit marker for if this business center is open on Sunday |
| Is_Open_Thursday | Bool | False |
Explicit marker for if this business center is open on Thursday |
| Is_Open_Tuesday | Bool | False |
Explicit marker for if this business center is open on Tuesday |
| Is_Open_Wednesday | Bool | False |
Explicit marker for if this business center is open on Wednesday |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| Monday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Monday |
| Monday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Monday |
| Monday_Open_Hour | String | False |
The hour portion of the time this business center is open on Monday |
| Monday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Monday |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Saturday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Saturday |
| Saturday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Saturday |
| Saturday_Open_Hour | String | False |
The hour portion of the time this business center is open on Saturday |
| Saturday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Saturday |
| Sunday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Sunday |
| Sunday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Sunday |
| Sunday_Open_Hour | String | False |
The hour portion of the time this business center is open on Sunday |
| Sunday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Sunday |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Thursday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Thursday |
| Thursday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Thursday |
| Thursday_Open_Hour | String | False |
The hour portion of the time this business center is open on Thursday |
| Thursday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Thursday |
| Timezone | String | False |
Time Zone in which this Shift operates |
| Tuesday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Tuesday |
| Tuesday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Tuesday |
| Tuesday_Open_Hour | String | False |
The hour portion of the time this business center is open on Tuesday |
| Tuesday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Tuesday |
| Wednesday_Close_Hour | String | False |
The hour portion of the time this business center is closed on Wednesday |
| Wednesday_Close_Minutes | String | False |
The minute portion of the time this business center is closed on Wednesday |
| Wednesday_Open_Hour | String | False |
The hour portion of the time this business center is open on Wednesday |
| Wednesday_Open_Minutes | String | False |
The minute portion of the time this business center is open on Wednesday |
The Shippers table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Default_Cost | Decimal | True |
Default cost (Shown) |
| Default_Cost_Usdollar | Decimal | True | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| List_Order | Int | True | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Status | String | False | |
| Sync_Key | String | True | |
| Tag | String | False |
The Styleguide table.
| Name | Type | ReadOnly | Description |
| Alt_Address_City | String | False |
City for alternate address |
| Alt_Address_Country | String | False |
Country for alternate address |
| Alt_Address_Postalcode | String | False |
Postal code for alternate address |
| Alt_Address_State | String | False |
State for alternate address |
| Alt_Address_Street | String | False |
Street address for alternate address |
| Alt_Address_Street_2 | String | False | |
| Alt_Address_Street_3 | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Assistant | String | False |
Name of the assistant of the contact |
| Assistant_Phone | String | False |
Phone number of the assistant of the contact |
| Birthdate | Date | False |
The birthdate of the contact |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Currency_Id | String | False |
Currency of the product |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Start | Datetime | False |
Date of start of meeting |
| Deleted | Bool | False |
Record deletion indicator |
| Department | String | False |
The department of the contact |
| Description | String | False |
Full text of the styleguide page |
| Do_Not_Call | Bool | False |
Whether or not to allow calls to contact |
| String | False | ||
| Email_Addresses_Non_Primary | String | False | |
| Email_Opt_Out | Bool | False | |
| Email1 | String | False | |
| Email2 | String | False | |
| String | False |
The facebook name of the user | |
| File_Mime_Type | String | False |
Attachment MIME type |
| File_Url | String | False |
Path to file (can be URL) |
| Filename | String | True |
File name associated with the note (attachment) |
| First_Name | String | False |
First name of the contact |
| Following | Bool | False |
Is user following this record |
| Full_Name | String | True | |
| Googleplus | String | False |
The google plus id of the user |
| Id [KEY] | String | True |
Unique identifier |
| Invalid_Email | Bool | False | |
| Last_Name | String | False |
Last name of the contact |
| List_Price | Decimal | True |
List price of product ( |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | True | |
| Parent_Id | String | False |
The ID of the Sugar item specified in parent_type |
| Parent_Name | String | True | |
| Parent_Type | String | True |
Sugar module the Note is associated with |
| Phone_Fax | String | False |
Contact fax number |
| Phone_Home | String | False |
Don't call to this number |
| Phone_Mobile | String | False |
Mobile phone number of the contact |
| Phone_Other | String | False |
Other phone number for the contact |
| Phone_Work | String | False |
Work phone number of the contact |
| Picture | String | False |
Image to be used as an avatar |
| Primary_Address_City | String | False |
City for primary address |
| Primary_Address_Country | String | False |
Country for primary address |
| Primary_Address_Postalcode | String | False |
Postal code for primary address |
| Primary_Address_State | String | False |
State for primary address |
| Primary_Address_Street | String | False |
The street address used for primary address |
| Primary_Address_Street_2 | String | False | |
| Primary_Address_Street_3 | String | False | |
| Radio_Button_Group | String | True | |
| Salutation | String | False |
Contact salutation (e.g., Mr, Ms) |
| Secret_Password | String | True |
Your password will be saved securely |
| Sync_Key | String | True | |
| Title | String | True |
Title of the Styleguide page |
| String | False |
The twitter name of the user | |
| User_Email | String | False |
Emails can also have a big help description to further enhance the user experience |
| Website | String | False |
URL of website for the company |
The Subscriptions table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Parent_Id | String | False | |
| Parent_Type | String | False | |
| Sync_Key | String | True |
The SugarFavorites table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Name of the feed |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| Module | String | False | |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Record_Id | String | False | |
| Record_Name | String | True | |
| Sync_Key | String | True |
The SugarLive table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Enabled_Modules | String | False | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Sync_Key | String | True | |
| Tag | String | False |
The Tags table.
| Name | Type | ReadOnly | Description |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Name_Lower | String | False | |
| Source_Id | String | False | |
| Source_Meta | String | False | |
| Source_Type | String | False | |
| Sync_Key | String | True |
The Tasks table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Assigned_User_Id | String | False |
User ID assigned to record |
| Assigned_User_Name | String | True | |
| Cj_Activity_Completion_Date | Datetime | True | |
| Cj_Activity_Start_Date | Datetime | True | |
| Cj_Activity_Tpl_Name | String | True | |
| Cj_Actual_Sort_Order | String | False | |
| Cj_Allow_Activity_By | String | False | |
| Cj_Blocked_By_Stages | String | False | |
| Cj_Days_To_Complete | String | True | |
| Cj_Momentum_End_Date | Datetime | False | |
| Cj_Momentum_Points | Int | True | |
| Cj_Momentum_Ratio | Double | True | |
| Cj_Momentum_Score | Int | True | |
| Cj_Momentum_Start_Date | Datetime | False | |
| Cj_Parent_Activity_Id | String | False | |
| Cj_Parent_Activity_Type | String | False | |
| Cj_Url | String | False | |
| Commentlog | String | True | |
| Contact_Email | String | False | |
| Contact_Id | String | False | |
| Contact_Name | String | True | |
| Contact_Phone | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Customer_Journey_Blocked_By | String | False | |
| Customer_Journey_Points | String | False | |
| Customer_Journey_Progress | Double | True | |
| Customer_Journey_Score | Int | True | |
| Customer_Journey_Type | String | False | |
| Date_Due | Datetime | False | |
| Date_Due_Flag | Bool | False | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Date_Start | Datetime | False | |
| Date_Start_Flag | Bool | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Dri_Subworkflow_Id | String | False | |
| Dri_Subworkflow_Name | String | True | |
| Dri_Subworkflow_Template_Id | String | False | |
| Dri_Subworkflow_Template_Name | String | True | |
| Dri_Workflow_Id | String | False | |
| Dri_Workflow_Name | String | True | |
| Dri_Workflow_Sort_Order | String | False | |
| Dri_Workflow_Task_Template_Id | String | False | |
| Dri_Workflow_Template_Id | String | False | |
| Dri_Workflow_Template_Name | String | True | |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Is_Cj_Parent_Activity | Bool | False | |
| Is_Customer_Journey_Activity | Bool | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Parent_Id | String | False | |
| Parent_Name | String | True | |
| Parent_Type | String | True |
The Sugar object to which the call is related |
| Priority | String | False | |
| Start_Next_Journey_Id | String | False | |
| Status | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Time_Due | Datetime | False |
The TaxRates table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| List_Order | Int | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Status | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| Value | Decimal | False |
The TeamNotices table.
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True | |
| Acl_Team_Set_Id | String | False | |
| Created_By | String | True | |
| Date_End | Date | False | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Date_Start | Date | False | |
| Deleted | Bool | False | |
| Description | String | False | |
| Id [KEY] | String | True | |
| Modified_User_Id | String | True | |
| Name | String | False | |
| Status | String | False | |
| Team_Count | String | False | |
| Team_Id | String | False |
Team ID for the account |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Url | String | False | |
| Url_Title | String | False |
The Teams table.
| Name | Type | ReadOnly | Description |
| Associated_User_Id | String | False | |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Name_2 | String | False | |
| Private | Bool | False | |
| Sync_Key | String | True |
The TimePeriods table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| End_Date | Date | False | |
| End_Date_Timestamp | Int | False | |
| Id [KEY] | String | True | |
| Is_Fiscal | Bool | False | |
| Is_Fiscal_Year | Bool | False | |
| Leaf_Cycle | Int | True | |
| Name | String | True | |
| Parent_Id | String | False | |
| Start_Date | Date | False | |
| Start_Date_Timestamp | Int | False | |
| Type | String | False |
Time Period to be Forecast over |
The TrackerPerfs table.
| Name | Type | ReadOnly | Description |
| Date_Modified | Datetime | True | |
| Db_Round_Trips | Int | True | |
| Deleted | Bool | False |
Record deletion indicator |
| Files_Opened | Int | True | |
| Id [KEY] | Int | True | |
| Memory_Usage | Int | True | |
| Monitor_Id | String | False | |
| Server_Response_Time | Double | True |
The TrackerQueries table.
| Name | Type | ReadOnly | Description |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False |
Record deletion indicator |
| Id [KEY] | Int | True | |
| Query_Hash | String | False | |
| Query_Id | String | False | |
| Run_Count | Int | True | |
| Sec_Avg | Double | True | |
| Sec_Total | Double | True | |
| Text | String | False |
The Trackers table.
| Name | Type | ReadOnly | Description |
| Action | String | False | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False |
Record deletion indicator |
| Id [KEY] | Int | True | |
| Item_Id | String | False | |
| Item_Summary | String | False | |
| Module_Name | String | False | |
| Monitor_Id | String | False | |
| Session_Id | String | False | |
| Team_Id | String | False | |
| User_Id | String | False | |
| Visible | Bool | False |
The TrackerSessions table.
| Name | Type | ReadOnly | Description |
| Active | Bool | False | |
| Client_Ip | String | False | |
| Date_End | Datetime | False | |
| Date_Start | Datetime | False | |
| Deleted | Bool | False |
Record deletion indicator |
| Id [KEY] | Int | True | |
| Seconds | Int | True | |
| Session_Id | String | False | |
| User_Id | String | False |
The Users table.
| Name | Type | ReadOnly | Description |
| Accept_Status_Calls | String | False | |
| Accept_Status_Id | String | False | |
| Accept_Status_Meetings | String | False | |
| Accept_Status_Messages | String | False | |
| Accept_Status_Name | String | False | |
| Acl_Role_Set_Id | String | False | |
| Acl_Team_Set_Id | String | False | |
| Address_City | String | False | |
| Address_Country | String | False | |
| Address_Postalcode | String | False | |
| Address_State | String | False | |
| Address_Street | String | False | |
| Authenticate_Id | String | False | |
| Business_Center_Id | String | False |
The business center to which the case is associated |
| Business_Center_Name | String | True |
The name of the business center represented by the business_center_id field |
| C_Accept_Status_Fields | String | True | |
| Cookie_Consent | Bool | False |
Indicator whether this user accepts cookies |
| Cookie_Consent_Received_On | Datetime | False |
Date cookie consent received on |
| Created_By | String | True | |
| Created_By_Name | String | True | |
| Customer_Journey_Access | Bool | True | |
| Customer_Journey_Last_Active | Datetime | True | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Default_Team | String | False | |
| Deleted | Bool | False | |
| Department | String | False | |
| Description | String | False | |
| String | False | ||
| Email_Link_Type | String | False | |
| Email1 | String | False | |
| Employee_Status | String | False | |
| External_Auth_Only | Bool | False | |
| First_Name | String | False | |
| Full_Name | String | True | |
| Id [KEY] | String | True | |
| Is_Admin | Bool | False | |
| Is_Group | Bool | False | |
| Last_Login | Datetime | True | |
| Last_Name | String | False | |
| License_Type | String | False | |
| M_Accept_Status_Fields | String | True | |
| Messenger_Id | String | False | |
| Messenger_Type | String | False | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True | |
| Name | String | True | |
| Phone_Fax | String | False | |
| Phone_Home | String | False | |
| Phone_Mobile | String | False | |
| Phone_Other | String | False | |
| Phone_Work | String | False | |
| Picture | String | False | |
| Portal_Only | Bool | False | |
| Preferred_Language | String | False | |
| Pwd_Last_Changed | Datetime | False | |
| Receive_Notifications | Bool | False | |
| Reports_To_Id | String | False | |
| Reports_To_Name | String | True | |
| Send_Email_On_Mention | Bool | False | |
| Show_On_Employees | Bool | False | |
| Site_User_Id | String | True | |
| Status | String | False | |
| Sugar_Login | Bool | False | |
| Sync_Key | String | True | |
| System_Generated_Password | Bool | False | |
| Team_Count | String | False | |
| Team_Id | String | False | |
| Team_Name | String | False | |
| Team_Set_Id | String | False | |
| Title | String | False | |
| User_Hash | String | True | |
| User_Name | String | False | |
| Usertype | String | False |
The UserSignatures table.
| Name | Type | ReadOnly | Description |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Is_Default | Bool | False | |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Signature | String | False | |
| Signature_Html | String | False | |
| Sync_Key | String | True | |
| Tag | String | False | |
| User_Id | String | False |
The VisualPipeline table.
| Name | Type | ReadOnly | Description |
| Available_Columns | String | False |
An array of white-listed column names |
| Commentlog | String | True | |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Enabled_Module | String | False | |
| Following | Bool | False |
Is user following this record |
| Hidden_Values | String | False | |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False | |
| Records_Per_Column | String | False | |
| Show_Column_Count | Bool | False | |
| Show_Column_Total | Bool | False | |
| Sync_Key | String | True | |
| Table_Header | String | False | |
| Tag | String | False | |
| Tile_Body_Fields | String | False | |
| Tile_Header | String | False | |
| Total_Field | String | False |
The WebLogicHooks table.
| Name | Type | ReadOnly | Description |
| Created_By | String | True |
User who created record |
| Created_By_Name | String | True | |
| Date_Entered | Datetime | True |
Date record created |
| Date_Modified | Datetime | True |
Date record last modified |
| Deleted | Bool | False |
Record deletion indicator |
| Description | String | False |
Full text of the note |
| Following | Bool | False |
Is user following this record |
| Id [KEY] | String | True |
Unique identifier |
| Locked_Fields | String | True | |
| Modified_By_Name | String | True | |
| Modified_User_Id | String | True |
User who last modified record |
| My_Favorite | Bool | False |
Favorite for the user |
| Name | String | False |
Hook name |
| Request_Method | String | False | |
| Sync_Key | String | True | |
| Trigger_Event | String | False | |
| Url | String | False |
URL of website for the company |
| Webhook_Target_Module | String | False |
The WorkFlow table.
| Name | Type | ReadOnly | Description |
| Base_Module | String | False | |
| Created_By | String | True | |
| Date_Entered | Datetime | True | |
| Date_Modified | Datetime | True | |
| Deleted | Bool | False | |
| Description | String | False | |
| Fire_Order | String | False | |
| Id [KEY] | String | True | |
| List_Order_Y | Int | True | |
| Modified_User_Id | String | True | |
| Name | String | False | |
| Parent_Id | String | False | |
| Record_Type | String | False | |
| Status | Bool | False | |
| Type | String | False |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| 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. |
The Activities view.
| 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 |
The Audit view.
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'
| 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 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Module | String |
The DropDownValues View. This view provides information regarding the values of dropdowns from different fields and modules.
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.
| 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. |
The Relationships View. This view provides information regarding different relationships between tables.
| 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 から関連するレスポンスデータを返します。
| Name | Description |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、SugarCRM のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | データベース名。 |
| SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベース。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | テーブル名またはビュー名。 |
| TableType | String | テーブルの種類(テーブルまたはビュー)。 |
| Description | String | テーブルまたはビューの説明。 |
| IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Accounts テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts'
| 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 から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、StoredProc ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='StoredProc' AND Direction=1 OR Direction=2
| 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 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Accounts テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Accounts'
| 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
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前。 |
| KeySeq | String | 主キーのシーケンス番号。 |
| KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| 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 <> ''
| 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 準拠 を参照してください。
以下は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 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
| 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)。 |
| プロパティ | 説明 |
| User | 認証するSugarCRM ユーザーアカウントのユーザーID を指定します。 |
| 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. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| プロパティ | 説明 |
| 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 を使用しないクエリで返される最大行数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| User | 認証するSugarCRM ユーザーアカウントのユーザーID を指定します。 |
| 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. |
認証するSugarCRM ユーザーアカウントのユーザーID を指定します。
string
""
認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。
認証するユーザーアカウントのパスワードを指定します。
string
""
認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。
The version of the SugarCRM used.
string
"v11"
The SugarCRM API version used by default is v11_22.
The URL of the SugarCRM account in the form 'http://{sugar crm instance}.com'.
string
""
The URL of the SugarCRM account in the form http://{sugar crm instance}.com.
The SugarCRM platform that you want to use during your session.
string
"base"
Use this connection property if you are encountering a login conflict (error during authentication).
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:
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
string
""
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
string
""
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 プロパティの全リストを提供します。
| プロパティ | 説明 |
| 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 を使用しないクエリで返される最大行数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
The maximum number of results to return per page from SugarCRM.
int
1000
The Pagesize property affects the maximum number of results the Cloud returns per page from SugarCRM. Setting a higher value may result in better performance at the cost of additional memory consumption per page.
Note: The default max supported value is 1000.
Controls how aggregate columns are treated by the provider.
string
"ListAndRetrieve"
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. |
Controls how the 'link' type columns are exposed by the provider provider.
string
"Ignore"
The available options are detailed below:
| Ignore | All 'link' type columns will not be pushed by the provider. |
| Include | The 'link' type columns are used only for the Insertion of the related objects. This mode is useful for cases when we need to add relationships between Parent-Child objects. For instance, if we need to add comments to a Call we can use the 'commentlog_link' column and provide a comma-separated list of comment ids. |
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.
bool
false
Set this to true to use the table and column names from the UI.
Set this to false to use the API names for tables and columns.
The language used with the provider. This affects table names, view names and column names.
string
"English US"
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.
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')
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.
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.
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.
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.
string
"Accounts, Leads, Opportunities, Sales Order, Quotes, Calendar, Reports, Emails, Calls, Meetings, Tasks, Notes, NDA, Tracking Numbers, 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 this connection property to * if you like to expose the Reports 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 'Reports' table.
Specifies whether or not to flatten the objects' data for report views.
bool
true
If false, only the first-level objects are displayed as columns, and the values of non-primitive objects are pushed as JSON aggregates.
To access the values of those aggregates, you can use the JSON_EXTRACT function.
The default value is true.
Specifies the maximum depth of array elements to flatten for report views.
int
0
By default, the value is set to 0, meaning that only the first level will be pushed.
If the value is set to -1, all the levels will be flattened.
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.
Specify whether to get deleted records.
bool
false
Set this to true in order to retrieve deleted records in the result set.
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
For more information, please refer to the SugarCRM Indexes Documentation.
By default, this is set to true.
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
int
-1
このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
int
100
テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。
大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
int
60
このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。