You can create and manage connections with the Data Explorer and the FireDAC Connection Editor wizards. See Connection Definitions for more information on creating connections from code and creating persistent, private, or temporary connections.

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 component 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.

Caching SugarCRM Metadata

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in Caching Metadata.

Using the FireDAC Connection Editor

Complete the following steps to use the FireDAC Connection Editor to assign a SugarCRM connection to a TFDConnection object:

1. Open a project and drop a TFDPhysCDataSugarCRMDriverLink from the Tool Palette onto the Form Designer.
2. Drop a TFDConnection object onto the Form Designer.
3. Double-click the TFDConnection and select CDataSugarCRM in the Driver Id menu.
4. Define the necessary connection properties.
5. To execute ad-hoc SQL statements based on this connection, enter SQL commands on the SQL Script tab.
6. In the Form Designer, select the TFDConnection object and set the Connected property to true.

Using the Data Explorer

Complete the following steps to use the Data Explorer to define persistent connections that can be shared across applications and projects:

1. Click View > Tool Windows > Data Explorer in RAD Studio and expand the FireDAC node.
2. Right-click the CData SugarCRM Data Source node and click Add New Connection.
3. Enter a name for the connection. The FireDAC Connection Editor opens.

Working with Persistent Connections

The connections you define in the Data Explorer can be assigned to a TFDConnection object by specifying the connection name in the TFDConnection object's ConnectionDefName property.

Browsing Data and Metadata

The Data Explorer also provides options for browsing SugarCRM objects at design time:

• Expand the CData SugarCRM Data Source node in the Data Explorer to view the defined connections.
• Expand a connection node to find the database objects available for a connection.
• Drill down to a database object to find metadata such as primary keys.
• To display data, double-click a table or view or right-click and click View.