Getting Started

This page provides a guide to Establishing a Connection to SugarCRM in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to SugarCRM

Establishing a Connection shows how to authenticate to SugarCRM and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from SugarCRM through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to SugarCRM by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to SugarCRM

To establish a connection to SugarCRM, set URL to the URL associated with your SugarCRM account in the form http://{sugar crm instance}.com.

Authenticating to SugarCRM

To authenticate the Cloud to SugarCRM, set the following:

User: The user of the SugarCRM account.
Password: The password associated with the SugarCRM user.
Platform (optional): If you're encountering a login conflict during authentication, set this to one of the platforms that you have created in the SugarCRM UI.

By default, SugarCRM uses the "sugar" client id for authentication, but users can optionally specify the client Id and client secret values of a custom app. See Creating a Custom OAuth Application for more information.

OAuthClientId: Client Id of your custom OAuth app.
OAuthClientSecret: Client secret of your custom OAuth app.

Creating a Custom OAuth Application

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

Authenticating with Custom OAuth Consumer Keys

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

To create a new set of OAuth Consumer Keys:

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

When you connect the Cloud, it automatically:

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

SSL Configuration

Customizing the SSL Configuration

To enable TLS, set the following:

URL: Prefix the connection string with https://

With this configuration, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Cloud models entities in the SugarCRM API as an easy-to-use SQL database, using tables, views, and stored procedures. When you connect, the driver automatically retrieves the available entities and their metadata. Changes that you make in SugarCRM (for example, adding modules and fields or updating field types) are reflected immediately the next time that you connect.

The driver also supports custom modules and custom fields. You can query custom modules just like standard modules, and custom fields appear alongside the other columns in the corresponding tables or views.

Tables

The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your SugarCRM account. The following table includes a list of common tables and views:


Table	Description
Accounts	Stores information about organizations, companies, or individuals that a business maintains relationships with. This table includes account names, contact details, industry classifications, revenue attributes, and ownership structures that are used for customer management, sales planning, and reporting.
Activities	Provides a unified view of interactions such as calls, meetings, tasks, and emails across modules. This view helps users track engagement history and follow-up activity for accounts, contacts, and opportunities.
Campaigns	Stores marketing campaign configuration, scheduling, and targeting details. This table supports planning, execution, and performance evaluation across campaign channels.
Calls	Stores call interaction records, including call details, participants, and status. This table supports sales communication tracking, follow-up workflows, and engagement reporting.
Cases	Stores customer support case records. This table supports issue tracking, escalation management, service resolution workflows, and support performance reporting.
Contacts	Stores contact records representing individual people who are associated with accounts, opportunities, or leads. This table supports relationship management, communication workflows, and customer engagement activities.
EmailAddresses	Stores email address records that are linked to users, contacts, leads, and other entities. This table supports communication routing, contact identity resolution, and email activity tracking.
Emails	Stores inbound, outbound, and archived email message data. This table supports messaging history, communication audit, and engagement timelines.
Leads	Stores prospective customer records representing individuals or organizations that might convert into opportunities. This table supports lead qualification, nurturing workflows, and conversion tracking into contacts, accounts, and opportunities.
Meetings	Stores records representing scheduled meetings and meeting occurrences. This table supports appointment coordination, sales engagement tracking, and collaboration scheduling.
Notes	Stores user-authored notes and supplemental descriptive information that are linked to CRM records. This table supports collaboration, annotation of activity history, and contextual business documentation.
Opportunities	Stores revenue opportunity records representing potential deals in the sales pipeline. This table supports forecasting, sales stage progression, and revenue planning.
Products	Stores standard product records that are available for quoting and order processing. This table supports catalog management, pricing, and sales enablement.
Quotes	Stores sales quote records containing pricing proposals for potential deals. This table supports deal negotiation, approval workflows, and quote-to-order execution.
Relationships	Provides metadata describing how tables and records are related within SugarCRM. This view supports data modeling, dependency mapping, and relational schema analysis.
RevenueLineItems	Stores granular revenue projection and forecast line items. This table supports stage-based forecasting and revenue analytics.
Tags	Stores free-form tag values that are applied to records for classification. This table supports search, discovery, and categorization workflows.
Tasks	Stores task and to-do activity records. This table supports personal organization, follow-up tracking, and workflow execution.
Teams	Stores team definitions that determine row-level access and shared ownership. This table supports collaboration and access control.
Users	Stores user account and profile records. This table supports identity management, access control, and user authentication. The maximum page size for this table is 20.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including creating schema files, downloading document files, and obtaining the OAuth access token that is used for authentication with SugarCRM.

Tables

The Cloud models the data in SugarCRM as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - SugarCRM Tables


Name	Description
Accounts	Stores information about organizations, companies, or individuals that a business maintains relationships with. This table includes account names, contact details, industry classifications, revenue attributes, and ownership structures that are used for customer management, sales planning, and reporting.
ACLRoles	Stores Access Control List (ACL) role definitions. This table supports role-based authorization by grouping permission settings that determine user access capabilities across the system.
ArchiveRuns	Stores records of data archive execution events. This table helps administrators monitor data lifecycle operations and verify archive run outcomes.
Bugs	Stores defect and issue tracking records. This table supports product support workflows, root-cause analysis, and customer-reported problem resolution.
BusinessCenters	Stores information about business centers, including hours of operation and geographic service scope. This table supports scheduling logic, routing rules, and territory-based service management.
Calendar	Stores calendar configuration and view settings. This table supports personalized schedule visualization and shared activity coordination.
Calls	Stores call interaction records, including call details, participants, and status. This table supports sales communication tracking, follow-up workflows, and engagement reporting.
CampaignLog	Stores activity and response tracking data for marketing campaigns. This table supports performance attribution and engagement effectiveness analysis.
Campaigns	Stores marketing campaign configuration, scheduling, and targeting details. This table supports planning, execution, and performance evaluation across campaign channels.
CampaignTrackers	Stores tracking links that monitor campaign click-through and web engagement behavior. This table supports digital engagement analytics and response measurement.
Cases	Stores customer support case records. This table supports issue tracking, escalation management, service resolution workflows, and support performance reporting.
Categories	Stores hierarchical category definitions for organizing content and records. This table supports knowledge management, product classification, and list filtering.
ChangeTimers	Stores timing measurements that are associated with workflow transitions. This table supports service-level agreement (SLA) tracking and process performance analysis.
CJ_Forms	Stores Customer Journey form definitions and captured form submissions. This table supports guided selling, structured intake, and workflow-driven data collection.
CJ_WebHooks	Stores webhook endpoint configurations for Customer Journey automation events. This table supports real-time system integration and external process triggers.
CloudDrivePaths	Stores references to external cloud storage file locations. This table supports linking and retrieving documents that are stored outside the CRM system.
CommentLog	Stores threaded conversation entries that are attached to SugarCRM records. This table supports collaboration, context sharing, and discussion history tracking.
Comments	Stores user comment entries that provide additional context or commentary on records. This table supports communication history and annotation of business activity.
ConsoleConfiguration	Stores layout and configuration settings for the SugarCRM console interface. This table supports workspace customization and role-based dashboard experiences.
Contacts	Stores contact records representing individual people who are associated with accounts, opportunities, or leads. This table supports relationship management, communication workflows, and customer engagement activities.
Contracts	Stores contract agreement records and renewal details. This table supports contract lifecycle management, obligation tracking, and renewal planning.
ContractTypes	Stores contract type classification records. This table supports contract grouping, reporting segmentation, and standardized contract processing.
Currencies	Stores currency definitions and exchange rates. This table supports multi-currency transaction handling and standardized monetary value conversion.
CustomQueries	Stores saved query definitions that are used for advanced filtering or custom reporting. This table supports analytics, integration queries, and dataset reusability.
Dashboards	Stores dashboard configuration and component layout details. This table supports personalized workspace views, KPI visualization, and user productivity optimization.
DataArchiver	Stores rules and configurations for archiving historical data. This table supports data governance, storage optimization, and system performance tuning.
DataPrivacy	Stores data privacy request and consent management records. This table supports compliance with privacy regulations and customer data handling preferences.
DataSets	Stores dataset definitions that structure reporting and analytics output. This table supports visualization, metric aggregation, and cross-module data modeling.
DocumentMerges	Stores configuration rules that are used for document generation and template merging. This table supports automated production of customer-facing documents.
DocumentRevisions	Stores historical revisions of documents. This table supports version history tracking, rollback, and document change auditing.
Documents	Stores document metadata and content references. This table supports file storage, sharing, and record attachment workflows.
DocumentTemplates	Stores reusable document templates that define formatting and layout. This table supports standardized document generation across business processes.
DocuSignEnvelopes	Stores metadata for electronically signed document envelopes. This table supports signature tracking, validation, and document completion workflows.
DRI_SubWorkflows	Stores execution instances of Customer Journey sub-processes. This table supports step-level progress monitoring and guided interaction flows.
DRI_SubWorkflow_Templates	Stores template definitions for Customer Journey sub-process models. This table supports reusable, repeatable workflow patterns.
DRI_Workflows	Stores execution instances of Customer Journey workflows. This table supports journey progress tracking and customer engagement orchestration.
DRI_Workflow_Task_Templates	Stores reusable task templates for Customer Journey workflows. This table supports consistent task sequencing and repeatable engagement actions.
DRI_Workflow_Templates	Stores master Customer Journey workflow templates. This table supports guided selling and structured engagement program design.
EAPM	Stores External Account Password Management (EAPM) configuration and credential records. This table supports secure authentication and integration with third-party services.
EmailAddresses	Stores email address records that are linked to users, contacts, leads, and other entities. This table supports communication routing, contact identity resolution, and email activity tracking.
EmailMarketing	Stores records for marketing email campaign configuration and scheduling. This table supports campaign automation, outreach workflows, and performance reporting.
EmailParticipants	Stores participant relationships for email messages, including senders and recipients. This table supports communication tracking and collaboration analysis.
Emails	Stores inbound, outbound, and archived email message data. This table supports messaging history, communication audit, and engagement timelines.
EmailTemplates	Stores reusable email templates in text and HTML formats. This table supports consistent messaging, automated notifications, and campaign execution.
EmbeddedFiles	Stores embedded binary file attachments that are linked to CRM entities. This table supports documentation, artifact sharing, and reference file management.
Employees	Stores employee profile and account identity records used for authentication and internal user management. This table supports organizational structure representation and access control.
Escalations	Stores escalation request and resolution tracking records. This table supports service-level issue prioritization and response accountability.
ExternalUsers	Stores external portal user identities. This table supports partner, customer, or outside-user access to portal-based functionality.
Filters	Stores reusable filter and list-view configuration definitions. This table supports personalized data exploration, quick retrieval, and workflow efficiency.
ForecastManagerWorksheets	Stores forecast review worksheets that are created by managers during forecast roll-up cycles. This table supports collaborative forecast validation and revenue planning oversight.
Forecasts	Stores forecast values and planning data that are associated with specific time periods. This table supports performance tracking, revenue planning, and sales outlook analysis.
ForecastWorksheets	Stores individual user-level forecast worksheet entries. This table supports personalized pipeline assessment and forecasting adjustments.
Geocode	Stores geographic coordinate data that is derived from address fields. This table supports mapping, territory management, and proximity-based analytics.
HintAccountsets	Stores grouped account insights that are generated by Sugar Hint. This table supports enriched company intelligence and account research.
HintEnrichFieldConfigs	Stores configuration data that determines which fields are enriched by Sugar Hint. This table supports automated data enhancement and profile completion workflows.
HintNewsNotifications	Stores news and article notification records that are surfaced through Sugar Hint data enrichment. This table helps users stay aware of relevant company and contact updates that support research and engagement planning.
HintNotificationTargets	Stores routing and delivery configuration for Sugar Hint notification events. This table determines which users or systems receive enriched news and intelligence alerts.
Holidays	Stores records representing holidays and non-working dates. This table supports scheduling logic, resource planning, and automatic date adjustments in calendaring workflows.
InboundEmail	Stores configuration settings for inbound email accounts that are connected to SugarCRM. This table supports automated mailbox retrieval, assignment rules, and routing of email messages into CRM records.
KBArticles	Stores knowledge base (KB) article summary records such as titles, publishing details, and classification fields. This table supports customer self-service access, internal knowledge sharing, and case resolution workflows.
KBContents	Stores version-level content for knowledge base (KB) articles, including article body text and status metadata. This table supports version control, editorial review processes, and multi-language publication.
KBContentTemplates	Stores reusable content templates for authoring knowledge base (KB) articles. This table ensures consistent formatting and structure across published support and informational documents.
KBDocuments	Stores document references that are linked to knowledge base (KB) articles. This table supports attachments, supplemental reference materials, and documentation enhancements.
Leads	Stores prospective customer records representing individuals or organizations that might convert into opportunities. This table supports lead qualification, nurturing workflows, and conversion tracking into contacts, accounts, and opportunities.
Manufacturers	Stores manufacturer reference details used within product catalogs. This table supports supply chain tracking, vendor sourcing, and product grouping.
Meetings	Stores records representing scheduled meetings and meeting occurrences. This table supports appointment coordination, sales engagement tracking, and collaboration scheduling.
Messages	Stores records that represent message conversations and threaded communication. This table supports collaborative discussions and contextual communication history linked to CRM records.
Metrics	Stores configuration details for metric definitions that drive pipeline and performance visualization. This table supports reporting dashboards and role-based KPIs.
MobileDevices	Stores records representing mobile devices that are registered to access SugarCRM. This table supports device authentication, audit logging, and mobile security enforcement.
Notes	Stores user-authored notes and supplemental descriptive information that are linked to CRM records. This table supports collaboration, annotation of activity history, and contextual business documentation.
Notifications	Stores notification events that inform users of system changes, assignments, or activity updates. This table supports engagement awareness and timely workflow participation.
OAuthKeys	The OAuthKeys table.
OAuthTokens	The OAuthTokens table.
Opportunities	Stores revenue opportunity records representing potential deals in the sales pipeline. This table supports forecasting, sales stage progression, and revenue planning.
OutboundEmail	Stores configuration for outbound email servers and sending profiles. This table supports system-generated notifications and user-initiated messaging.
PdfManager	Stores PDF template definitions and formatting layouts. This table supports automated PDF generation for quotes, proposals, and reporting.
pmse_Business_Rules	Stores rule definitions that are used within the Advanced Workflow engine to drive conditional automation. This table supports decision logic execution across workflow paths.
pmse_Emails_Templates	Stores email templates that are used by Advanced Workflow processes. This table supports automated messaging and process-driven communication.
pmse_Inbox	Stores workflow task records that are assigned to users within the Advanced Workflow engine. This table supports queue management, task routing, and approval tracking.
pmse_Project	Stores model definitions for the Advanced Workflow process. This table supports business process automation and lifecycle management.
ProductBundleNotes	Stores descriptive notes that are associated with product bundles. This table supports documentation, internal context, and quoting rationale for bundled offerings.
ProductBundles	Stores records that represent bundled product groupings. This table supports multi-item pricing, quoting, and packaged sales offerings.
ProductCategories	Stores hierarchical category definitions for organizing products. This table supports catalog browsing, segmentation, and classification.
Products	Stores standard product records that are available for quoting and order processing. This table supports catalog management, pricing, and sales enablement.
ProductTemplates	Stores reusable template records that define product configuration defaults. This table supports consistent product setup and catalog scalability.
ProductTypes	Stores product type classification values. This table supports segmentation, reporting, and filtering of product offerings.
Project	Stores project records representing structured work initiatives. This table supports project planning, resource scheduling, and execution oversight.
ProjectTask	Stores task records that are associated with projects. This table supports task assignment, progress tracking, and project activity management.
ProspectLists	Stores targeted prospect list definitions that are used for marketing outreach. This table supports segmentation, campaign targeting, and audience selection.
PubSub_ModuleEvent_PushSubs	Stores push subscription configurations for module event notifications. This table supports real-time integration and event-driven automation.
PurchasedLineItems	Stores individual purchase line-item records. This table supports purchase history analysis, revenue attribution, and customer value insights.
Purchases	Stores summarized purchase records that are linked to accounts or contacts. This table supports customer lifecycle management and sales effectiveness analysis.
PushNotifications	Stores records representing push notification events that are delivered to users or devices. This table supports real-time engagement and alert-driven workflows.
Quotas	Stores sales quota assignments for users or teams over specific time periods. This table supports performance measurement and goal tracking.
Quotes	Stores sales quote records containing pricing proposals for potential deals. This table supports deal negotiation, approval workflows, and quote-to-order execution.
Releases	Stores software release and versioning records. This table supports deployment management and compatibility tracking.
ReportMaker	Stores report template and layout configuration records. This table supports custom reporting and analytics generation.
Reports	Stores report definitions and display parameters. This table supports operational reporting, metrics visualization, and data analysis.
ReportSchedules	Stores schedules that control automated report generation and delivery. This table supports recurring analytics distribution and scheduled insights.
RevenueLineItems	Stores granular revenue projection and forecast line items. This table supports stage-based forecasting and revenue analytics.
SavedSearch	Stores saved search definitions for reusable filtering criteria. This table supports quick recall of commonly used list views and data queries.
Schedulers	Stores scheduled job definitions and execution metadata. This table supports automated background processing and timed workflow tasks.
ShiftExceptions	Stores schedule exception records that are related to shift assignments. This table supports workforce planning and conflict resolution.
Shifts	Stores shift schedule assignments for users or resources. This table supports operational staffing and availability planning.
Shippers	Stores shipping provider records that are used in fulfillment workflows. This table supports order fulfillment and logistics management.
Styleguide	Stores UI configuration and styling guidelines. This table supports interface consistency and user experience standardization.
Subscriptions	Stores subscription and feed-follow relationships. This table supports record tracking, content syndication, and notification preference management.
SugarFavorites	Stores references to user-favorited records. This table supports quick navigation and personalized workspace organization.
SugarLive	Stores communication session details for SugarLive interactions. This table supports real-time customer engagement and conversation tracking.
Tags	Stores free-form tag values that are applied to records for classification. This table supports search, discovery, and categorization workflows.
Tasks	Stores task and to-do activity records. This table supports personal organization, follow-up tracking, and workflow execution.
TaxRates	Stores tax rate definitions used in pricing and billing. This table supports financial compliance and transaction accuracy.
TeamNotices	Stores announcements that are broadcast to team members. This table supports internal communication and organization-wide updates.
Teams	Stores team definitions that determine row-level access and shared ownership. This table supports collaboration and access control.
TimePeriods	Stores time period structures that are used in forecasting and reporting. This table supports standardized analysis intervals and planning cycles.
TrackerPerfs	Stores performance tracking metrics for user or system activity. This table supports system performance optimization and usage monitoring.
TrackerQueries	Stores logged query-execution records. This table supports diagnostic analysis and query performance tuning.
Trackers	Stores user and system activity tracking records. This table supports operational analytics, historical review, and audit trails.
TrackerSessions	Stores user session metadata. This table supports authentication tracking and session governance.
Users	Stores user account and profile records. This table supports identity management, access control, and user authentication. The maximum page size for this table is 20.
UserSignatures	Stores saved email signature templates for users. This table supports consistent branding and personalization in outbound emails.
VisualPipeline	Stores configuration settings for pipeline visualization dashboards. This table supports graphical opportunity review and sales stage analysis.
WebLogicHooks	Stores configuration for custom business logic hooks that are triggered by system events. This table supports extensibility and integration workflows.
WorkFlow	Stores rule definitions for legacy workflow processes. This table supports automated condition-based workflow execution for older workflow components.


Name	Type	ReadOnly	Description
Base_Module	String	False	The module on which this workflow is based (for example, 'Accounts', 'Leads', or 'Opportunities'). This value determines where the workflow rules apply.
Created_By	String	True	The unique identifier (Id) of the user who created this workflow record. This value supports ownership tracking and administrative auditing.
Date_Entered	Datetime	True	The date and time when this workflow record was created. This value supports lifecycle monitoring and audit review.
Date_Modified	Datetime	True	The date and time when this workflow record was most recently updated. This value provides visibility into workflow maintenance and revision activity.
Deleted	Bool	False	A Boolean field that returns a value of 'true' when this workflow record is marked as deleted. It returns a value of 'false' when the record remains active and available.
Description	String	False	A detailed description of the workflow, including its purpose or intended effect. This value provides business context and documentation.
Fire_Order	String	False	The position in which this workflow triggers relative to other workflows on the same module. This value determines execution sequence.
Id [KEY]	String	True	The Id for this workflow record. This value uniquely identifies the workflow within the system.
List_Order_Y	Int	True	The vertical display position of the workflow in workflow list views. This value affects how workflows are visually ordered in the interface.
Modified_User_Id	String	True	The Id of the user who most recently updated this workflow record. This value identifies the source of the latest workflow modification.
Name	String	False	The display name of the workflow. This value appears in workflow lists, administrative tools, and configuration screens.
Parent_Id	String	False	The Id of the parent workflow or related workflow structure. This value supports workflow hierarchy and dependency management.
Record_Type	String	False	The type of record or scenario in which the workflow applies (for example,'creation', 'update', or 'scheduled evaluation'. This value defines workflow applicability.
Status	Bool	False	A Boolean field that returns a value of 'true' when this workflow is currently active and eligible to trigger. It returns a value of 'false' when the workflow is disabled or inactive.
Type	String	False	The classification of the workflow, such as a trigger-based or a workflow action type. This value determines how and when workflow logic is executed.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - SugarCRM Views


Name	Description
ACLActions	Provides reference details for Access Control List (ACL) permissions in SugarCRM. This view lists the specific system actions that can be granted or restricted for user roles to enforce module-level and feature-level access security.
Activities	Provides a unified view of interactions such as calls, meetings, tasks, and emails across modules. This view helps users track engagement history and follow-up activity for accounts, contacts, and opportunities.
Audit	Provides a change history of audited fields across modules. This view supports compliance tracking, troubleshooting, and record-level change review.
DropDownValues	Provides field dropdown option definitions across modules. This view supports UI selection lists and ensures consistent controlled vocabulary values.
Relationships	Provides metadata describing how tables and records are related within SugarCRM. This view supports data modeling, dependency mapping, and relational schema analysis.

ACLActions

Provides reference details for Access Control List (ACL) permissions in SugarCRM. This view lists the specific system actions that can be granted or restricted for user roles to enforce module-level and feature-level access security.

Columns


Name	Type	Description
Id [KEY]	String	This field stores the unique identifier (Id) that is assigned to each Access Control List (ACL) action record. This Id ensures that every ACL action can be uniquely referenced within the system.
Name	String	This field specifies the name of the Access Control List (ACL) action. The value identifies the system or user-defined name that represents a specific permission or access operation.
DateModified	Datetime	This field records the date and time when the ACL action record was last modified. The value is used for synchronization and audit tracking to ensure that updates to permission data are properly recorded.
CreatedBy	String	This field stores the Id of the user who created the ACL action record. The value supports audit tracking and ownership identification for access control configurations.
ModifiedUserId	String	This field stores the Id of the user who last modified the ACL action record. The value helps track user accountability and change history for permission settings.
Category	String	This field defines the category of the Access Control List (ACL) action. The category identifies the module or component within SugarCRM to which the permission applies.
ACLType	String	This field specifies the type of Access Control List (ACL) action that determines how the permission is applied within a module. The value indicates whether the action applies to module-level, field-level, or record-level access.
ACLAccess	Int	This field defines the numeric access level that is granted for a specific action or field within a module. The value establishes the degree of permission, such as no access, read-only access, or full access.
AccessOverride	Int	This field specifies the numeric value that enforces a default access level and overrides role-based permissions when it is set. The value allows administrators to establish baseline access rules for modules or fields.
ACL	String	This field defines the Access Control List (ACL) value that is associated with the action. The value determines the system behavior that is controlled by the corresponding access setting.
Deleted	Bool	A Boolean field returns a value of 'true' when the ACL action record has been marked as deleted. It returns a value of 'false' when the record remains active. This field supports soft-delete functionality to retain historical data for audit purposes.

Activities

Provides a unified view of interactions such as calls, meetings, tasks, and emails across modules. This view helps users track engagement history and follow-up activity for accounts, contacts, and opportunities.

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier (Id) for this activity record. This field ensures that the record can be referenced reliably across related modules.
Name	String	The display name or descriptive label for this activity. This field helps users identify the activity in lists, dashboards, and history views.
Date_Entered	Datetime	The date and time when this activity record is created in the system. This field supports lifecycle auditing and historical reporting.
Date_Modified	Datetime	The date and time when this activity record is most recently modified. This field enables users to track changes over time.
Modified_User_Id	String	The Id of the user who most recently modified this activity record. This field supports auditing of update responsibility.
Modified_By_Name	String	The name of the user who most recently modified this activity record. This field provides a readable reference for the Modified_User_Id field.
Created_By	String	The Id of the user who originally created this activity record. This field ensures traceability for initial record creation.
Created_By_Name	String	The name of the user who originally created this activity record. This field provides a readable reference for the created_by field.
Description	String	A narrative or explanatory note that describes the context or details of the activity. This field supports collaboration and historical review.
Deleted	Bool	A Boolean field that returns a value of 'true' when the activity record is marked for deletion. It returns a value of 'false' when the record remains active. This field supports soft-delete workflows and record recovery.
Parent_Id	String	The Id of the parent record that is associated with this activity. This field establishes the relationship between the activity and its originating module.
Parent_Type	String	The module or entity type of the parent record that is associated with this activity. This field allows the system to interpret the meaning of the Parent_Id field.
Activity_Type	String	The classification of the activity, such as call, meeting, task, or email. This field supports sorting, filtering, and reporting on activity types.
Data	String	Serialized or structured data that is associated with this activity. This field can store metadata or system-generated detail that is required by activity sources.
Comment_Count	Int	The number of comments that are associated with this activity. This field supports engagement analysis and collaboration tracking.
Last_Comment	String	The content of the most recent comment that is posted on this activity. This field provides quick visibility into the latest discussion context.
Following	Bool	A Boolean field that returns a value of 'true' when the current user is following this activity to receive updates. It returns a value of 'false' when the user is not subscribed to follow the record.
My_Favorite	Bool	A Boolean field that returns a value of 'true' when the current user marks this activity as a favorite. It returns a value of 'false' when the record is not marked as a favorite.
Locked_Fields	String	The list of fields that are locked and cannot be modified for this activity record. This field helps maintain data integrity in controlled situations.
Sync_Key	String	The synchronization key that links this activity to external systems or data sources. This field supports cross-system data consistency.

Audit

Provides a change history of audited fields across modules. This view supports compliance tracking, troubleshooting, and record-level change review.

Table Specific Information

Select

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

SELECT * FROM Audit WHERE Module = 'Contacts'

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

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

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

Columns


Name	Type	Description
Parent_Id	String	The unique identifier (Id) of the record that this audit entry is associated with. This field links the audit entry back to the original record for change tracking.
Date_Created	Datetime	The date and time when this audit record was created. This field supports historical tracking of changes within the system.
Created_By	String	The Id of the user who created this audit entry. This field identifies who initiated the change being recorded.
Created_By_Username	String	The username of the user who created this audit entry. This field provides a readable reference for the Created_By field.
Field_Name	String	The name of the field that is modified. This field identifies which specific data element is changed in the parent record.
Data_Type	String	The data type of the field that is modified, such as string, integer, boolean, or date. This field is used to interpret before and after values correctly.
Before_Value_String	String	The previous value of the modified field before the change occurs. This field supports auditing and rollback analysis.
After_Value_String	String	The new value of the modified field after the change occurs. This field shows the result of the modification.
Before	String	The prior stored value for the modified field, formatted for system use or internal processing. This field supports data comparison and integrity checks.
After	String	The current stored value for the modified field, formatted for system use or internal processing. This field supports consistent system-level representation.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Module	String	The name of the module that this audit entry is associated with. This field enables the system to group, filter, and report audit events by module context.

DropDownValues

Provides field dropdown option definitions across modules. This view supports UI selection lists and ensures consistent controlled vocabulary values.

Table Specific Information

Select

The Cloud uses the SugarCRM API to process WHERE clause conditions that are built with the following columns and operators:

Module supports the = comparison operator.
Field supports the = comparison operator.

When querying DropDownValues, you can retrieve label values for an existing dropdown list associated with a module. To return these values, specify both the Module name and the Field that contains the dropdown item (both are required).

The following query is processed server-side:

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

If you want to create a custom dropdown list, it must be linked to a custom field that belongs to the module.

Note: If necessary, create a new custom field by navigating to Admin Panel > Studio > Accounts > Fields > Add Field.

Set the field type to dropdown, and create or select the custom dropdown list.

Columns


Name	Type	Description
Module	String	The name of the SugarCRM module in which this drop-down item is defined. This value determines where the dropdown appears in the user interface and which records can use it.
Field	String	The field within the module that uses this drop-down item. This value establishes where the item is displayed and selected during record creation or editing.
ItemName	String	The internal name of the drop-down item. This value is stored in the database and is used for system logic, automation rules, and reporting.
DisplayLabel	String	The user-facing label that appears in the drop-down menu. This value provides the readable text that end users select when interacting with the application.

Relationships

Provides metadata describing how tables and records are related within SugarCRM. This view supports data modeling, dependency mapping, and relational schema analysis.

Columns


Name	Type	Description
Name	String	The name of the relationship. This value uniquely distinguishes the relationship definition within the system.
DynamicSubpanel	String	The dynamic subpanel that is associated with this relationship. This value determines how the relationship is displayed within the user interface.
JoinKeyLhs	String	The join key value on the left-hand side of the relationship. This field identifies the column that is used to establish the relationship from the left module.
JoinKeyRhs	String	The join key value on the right-hand side of the relationship. This field identifies the column that is used to establish the relationship from the right module.
JoinTable	String	The name of the join table that links the left and right modules in the relationship. This table stores the cross-referenced relationship records.
LhsKey	String	The key column on the left-hand side module that participates in the relationship. This value is used to establish linkage and matching logic.
LhsModule	String	The module on the left-hand side of the relationship. This value identifies the primary module that participates in the relationship.
LhsTable	String	The database table that corresponds to the left-hand side module. This value determines where the left module's records are stored.
RelationshipRoleColumn	String	The column that determines a role-based variation of the relationship. This value enables conditional or filtered relationship behavior.
RelationshipRoleColumnValue	String	The value of the role column that activates or defines the relationship's scope. This value is used to enforce role-specific linking conditions.
RelationshipType	String	The relationship type (for example, 'one-to-one', 'one-to-many', or 'many-to-many'). This value indicates how records are associated across modules.
PrimaryFlagColumn	String	The column that indicates the primary record in a group of related records. This value helps determine which record should be treated as dominant or preferred.
PrimaryFlagDefault	String	The default value that is applied to the primary flag column when no explicit value is defined. This value establishes baseline relationship behavior.
PrimaryFlagSide	String	The side of the relationship on which the primary flag applies (for example, 'left' or 'right'). This value identifies which module determines primary status.
RhsKey	String	The key column on the right-hand side module that participates in the relationship. This value is used to establish linkage and matching logic.
RhsModule	String	The module on the right-hand side of the relationship. This value identifies the secondary module that participates in the relationship.
RhsTable	String	The database table that corresponds to the right-hand side module. This value determines where the right module's records are stored.
TrueRelationshipType	String	The underlying system relationship type that governs actual linking behavior, which can differ from the displayed relationship type for legacy or UI purposes.
UserField	String	The name of the user field that is associated with the relationship. This value can be used to track ownership, assignment, or user-specific metadata within the relationship.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with SugarCRM.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SugarCRM, along with an indication of whether the procedure succeeded or failed.

CData Cloud - SugarCRM Stored Procedures


Name	Description

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for SugarCRM:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Accounts table:

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

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the StoredProc stored procedure:

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

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

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native SugarCRM procedure.

Pseudo-Columns


Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Accounts table:

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

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported 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	Supported 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	Supported date/time 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	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	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	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's 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.

OAuth

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

Property	Description
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	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
APIVersion	The version of the SugarCRM used.
URL	The URL of the SugarCRM account in the form 'http://{sugar crm instance}.com'.
Platform	The SugarCRM platform that you want to use during your session.

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

To create a new platform in SugarCRM:

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

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	`ecadbdda5a1529c58a1e9e09828d70e4`
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

BrowsableSchemas

Remarks

The available aggregate column modes are detailed below:


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

LinkColumnsMode

Remarks

The default language used is 'English US'.

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

IncludeRelationships

Set this to true if you want to expose relationship columns, which give you the ability to query objects in relation to other objects.

Data Type

bool

Default Value

false

Remarks

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

For example:

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

IncludeFiltersAsViews

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

Data Type

bool

Default Value

true

Remarks

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

SELECT * FROM [Filter_Cases_Open Cases]

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

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

ModulesFiltersList

Each SugarCRM module has named filters. This property enables you to control the list of filters that the provider exposes (as a view) for each module.

Data Type

string

Default Value

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

Remarks

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

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

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

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

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

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

IncludeReports

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

Data Type

bool

Default Value

false

Remarks

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

SELECT * FROM [Report_Revenues per industry (2021)]

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

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

ReportModulesList

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

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

IncludeDeleted

Specify whether to get deleted records.

Data Type

bool

Default Value

false

Remarks

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

ServerSideOrderBy

Set this to true if you want to perform the order by operation server-side. Keep in mind that having or creating indexes results in the best query performance.

Data Type

bool

Default Value

true

Remarks

For more information, please refer to the SugarCRM Indexes Documentation.

By default, this is set to true.

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

RowScanDepth

The maximum number of rows to scan to look for the columns available in a table.

Data Type

int

Default Value

100

Remarks

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

ThrowsKeyNotFound

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Cloud

SugarCRM - CData Cloud

Overview

Key Features

Getting Started

Connecting to SugarCRM

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to SugarCRM

Authenticating to SugarCRM

Creating a Custom OAuth Application

Creating a Custom OAuth Application

Authenticating with Custom OAuth Consumer Keys

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Stored Procedures

Tables

CData Cloud - SugarCRM Tables

Accounts

Columns

ACLRoles

Columns

ArchiveRuns

Columns

Bugs

Columns

BusinessCenters

Columns

Calendar

Columns

Calls

Columns

CampaignLog

Columns

Campaigns

Columns

CampaignTrackers

Columns

Cases

Columns

Categories

Columns

ChangeTimers

Columns

CJ_Forms

Columns

CJ_WebHooks

Columns

CloudDrivePaths

Columns

CommentLog

Columns

Comments

Columns

ConsoleConfiguration

Columns

Contacts

Columns

Contracts

Columns

ContractTypes

Columns

Currencies

Columns

CustomQueries

Columns

Dashboards

Columns

DataArchiver

Columns

DataPrivacy

Columns

DataSets

Columns