Ready to get started?

Learn more about CData Cloud Hub or sign up for a free trial:

Learn More

Connect to Act CRM Data as a Federated Tables in MySQL

Use the CData Cloud Hub to set up federated tables for Act CRM data in MySQL .

You can use the CData Cloud Hub to set up federated tables in MySQL for Act CRM data. The Cloud Hub provides a MySQL interface for Act CRM: After configuring a virtual MySQL database for Act CRM, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Act CRM data just as you would local MySQL tables.

The CData Cloud Hub provides a pure MySQL, cloud-to-cloud interface for Act CRM, allowing you to easily query live Act CRM data alongside existing MySQL data — all without replicating the data. Using optimized data processing out of the box, the CData Cloud Hub pushes all supported SQL operations (filters, JOINs, etc) directly to Act CRM, leveraging server-side processing to quickly return Act CRM data.

Create a Virtual MySQL Database for Act CRM Data

CData Cloud Hub uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Cloud Hub and click Databases.
  2. Select "Act CRM" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to Act CRM.

    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.

  4. Click Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Act CRM data from any MySQL client.

Create a FEDERATED Server and Tables for Act CRM Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the Cloud Hub. Note that the username and password of the FEDERATED server must match a user account you defined on the Cloud Hub.

CREATE SERVER fedActCRM
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'cloud_hub_user', PASSWORD 'cloud_hub_passwd', HOST 'myinstance.cdatacloud.net', PORT 3306, DATABASE 'actcrmdb');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (Activities). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_activities (
  ...,
  activitydisplayname  TYPE(LEN),
  subject  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=utf8
CONNECTION='fedActCRM/Activities';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the Cloud Hub using any MySQL client and run SHOW COLUMNS FROM Activities to get the table schema.

Execute Queries

You can now execute queries to the Act CRM FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Act CRM. Refer to the following example:

SELECT 
  fed_activities.activitydisplayname, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_activities 
ON 
  local_table.foreign_activitydisplayname = fed_activities.activitydisplayname;