Learn more
 

Ready to get started?

Download a free trial of the Act CRM ODBC Driver to get started:

 Download Now

Learn more:

Act CRM Icon Act CRM ODBC Driver

The Act CRM ODBC Driver is a powerful tool that allows you to connect with live Act CRM, directly from any applications that support ODBC connectivity.

Access Act CRM like you would a database - query Companies, Contact, Groups, Opportunities, etc. through a standard ODBC Driver interface.

In this article

Related articles

DataBind Controls to Act CRM Data in C++Builder


DataBind to Act CRM data in C++Builder with standard components and controls.

The CData ODBC Driver for Act CRM makes it easy to integrate connectivity to live Act CRM data with standard data access components in C++Builder. This article shows how to create a simple visual component library (VCL) application in C++Builder that connects to Act CRM data, executes queries, and displays the results in a grid. An additional section shows how to use FireDAC components to execute commands from code.

Create a Connection to Act CRM Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

The User and Password properties, under the Authentication section, must be set to valid Act! user credentials. In addition to the authentication values, see the following:

  • Connecting to Act! Premium

    In addition to the authentication values, the URL to Act! is also required; for example https://eup1-iis-04.eu.hosted.act.com/.

    Additionally, you must specify the ActDatabase you will connect to. This is found by going to the About Act! Premium menu of your account, at the top right of the page, in the ? menu. Use the Database Name in the window that appears.

  • Connecting to Act! Premium Cloud

    To connect to your Act! Premium Cloud account, you also need to specify the ActCloudName property. This property is found in the URL address of the Cloud account; for example https://eup1-iis-04.eu.hosted.act.com/ActCloudName/.

Note that retrieving ActCRM metadata can be expensive. It is advised that you set the CacheMetadata property to store the metadata locally.

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Act CRM.

  1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Act CRM.

Create VCL Applications with Connectivity to Act CRM Data

Follow the procedure below to start querying Act CRM data from a simple VCL application that displays the results of a query in a grid.

  1. Drop a TFDConnection component onto the form and set the following properties:

    • ConnectionDefName: Select the FireDAC connection to Act CRM.
    • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.

  2. Drop a TFDQuery component onto the form and set the properties below:

    • Connection: Set this property to the TFDConnection component, if this component is not already specified.

    • SQL: Click the button in the SQL property and enter a query. For example:

      SELECT ActivityDisplayName, Subject FROM Activities
    • Active: Set this property to true.

  3. Drop a TDataSource component onto the form and set the following property:

    • DataSet: In the menu for this property, select the name of the TFDQuery component.

  4. Drop a TDBGrid control onto the form and set the following property:

    • DataSource: Select the name of the TDataSource.
  5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

Execute Commands to Act CRM with FireDAC Components

You can use the TFDConnection and TFQuery components to execute queries to Act CRM data. This section provides Act CRM-specific examples of executing queries with the TFQuery component.

Connect to Act CRM Data

To connect to the data source, set the Connected property of the TFDConnection component to true. You can set the same properties from code:

FDConnection1->ConnectionDefName = "CData Act CRM ODBC Source"; FDConnection1->Connected = true;

To connect the TFDQuery component to Act CRM data, set the Connection property of the component. When a TFDQuery component is added at design time, its Connection property is automatically set to point to a TFDConnection on the form, as in the application above.

Create Parameterized Queries

To create a parameterized query, use the following syntax below:

FDQuery1->SQL->Text = "select * from Activities where subject = :Subject"; FDQuery1->ParamByName("subject")->AsString = "Sample subject"; query->Open();

The example above binds a string-type input parameter by name and then opens the dataset that results.

Prepare the Statement

Preparing statements is costly in system resources and time. The connection must be active and open while a statement is prepared. By default, FireDAC prepares the query to avoid recompiling the same query over and over. To disable statement preparation, set ResourceOptions.DirectExecute to True; for example, when you need to execute a query only once.

Execute a Query

To execute a query that returns a result set, such as a select query, use the Open method. The Open method executes the query, returns the result set, and opens it. The Open method will return an error if the query does not produce a result set.

FDQuery1->SQL->Text := "select * from Activities where subject = :Subject"; FDQuery1.ParamByName("subject")->AsString = "Sample subject"; FDQuery1->Open();

To execute a query that does not return a result set, use the ExecSQL method. The ExecSQL method will return an error if the query returns a result set. To retrieve the count of affected rows use the TFD.RowsAffected property.

FDQ.SQL.Text := "delete from Activities where Id = :Id"; FDQuery1->Params->Items[0]->AsString = "x12345"; FDQuery1->ExecSQL(); AnsiString i = FDQuery1->RowsAffected;