DataBind Controls to EmailOctopus Data in Delphi

The CData ODBC driver for EmailOctopus supports the ODBC standard to enable integration of live EmailOctopus data with visual form designers and other rapid development tools in Delphi. The ODBC driver simplifies data access strategies for applications that share a single codebase like Delphi by providing a single API for database development. This article shows how to how to connect to EmailOctopus data and query data from a simple visual component library (VCL) application, as well as from Delphi code.

Create a Connection to EmailOctopus 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.

Start by setting the Profile connection property to the location of the EmailOctopus Profile on disk (e.g. C:\profiles\EmailOctopus.apip). Next, set the ProfileSettings connection property to the connection string for EmailOctopus (see below).

EmailOctopus API Profile Settings

Sign into your EmailOctopus account and navigate to Integrations & API > API > Your API Keys to generate or retrieve your API key.

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

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

Create VCL Applications with Connectivity to EmailOctopus Data

Follow the procedure below to start executing queries to EmailOctopus 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 EmailOctopus data.
   • 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 CampaignId, ContactId FROM CampaignReportBounced WHERE ContactStatus = 'bounced'
     

   • 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 EmailOctopus with FireDAC Components

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

Connect to EmailOctopus 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 := 'myemailoctopus';
FDConnection1.Connected := true;

Create Parameterized Queries

Parameterized resources can improve performance: 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.Open('select * from CampaignReportBounced where ContactStatus = :ContactStatus',['bounced']);

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to EmailOctopus Data in C++Builder
• Viewing EmailOctopus Data in RAD Studio Data Explorer
• Build a Simple VCL Application for EmailOctopus Data