Connect to Act CRM Data in Aqua Data Studio

The CData JDBC Driver for Act CRM integrates Act CRM data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Act CRM data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Act CRM data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Act CRM.
   • Driver Location: Click the Browse button and select the cdata.jdbc.actcrm.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.actcrm.ActCRMDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:actcrm: and is followed by a semicolon-separated list of connection properties.

     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.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Act CRM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.actcrm.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     A typical JDBC URL is below:
     jdbc:actcrm:URL=https://myActCRMserver.com;User=myUser;Password=myPassword;ActDatabase=MyDB;

Query Act CRM Data

You can now query the tables exposed.