VOOZH about

URL: https://www.cdata.com/kb/tech/actcrm-jdbc-squirrel-sql.rst

⇱ How to connect to Act CRM Data with Squirrel SQL client


How to connect to Act CRM Data with Squirrel SQL client

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Act CRM data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for Act CRM enables you to execute queries to Act CRM data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Act CRM data and execute queries.

Add the JDBC Driver for Act CRM

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Act CRM.
  4. In the Example URL box, enter jdbc:actcrm:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.actcrm.ActCRMDriver.
πŸ‘ The definition for the JDBC data source. (Salesforce is shown.)

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData Act CRM Source.
    • Driver: Select the CData JDBC Driver for Act CRM.
    • URL: Enter jdbc:actcrm:
    πŸ‘ The alias definition, containing the connection parameters. (Salesforce is shown.)
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    The and 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 to Act! is also required; for example https://eup1-iis-04.eu.hosted.act.com/.

      Additionally, you must specify the 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 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 property to store the metadata locally.

    Below is a typical connection string:

    jdbc:actcrm:URL=https://myActCRMserver.com;User=myUser;Password=myPassword;ActDatabase=MyDB;
    
    πŸ‘ Connection properties automatically detected by Squirrel SQL. (Salesforce is shown.)
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Act CRM Data

After the metadata has loaded, a new tab for the Act CRM data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

πŸ‘ Column metadata for a table. (Salesforce is shown.)

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

πŸ‘ Tables can be edited on the Content tab. (Salesforce is shown.)

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT ActivityDisplayName, Subject FROM Activities
πŸ‘ A query and the results. (Salesforce is shown.)

Ready to get started?

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

 Download Now

Learn more:

πŸ‘ Act CRM Icon
Act CRM JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Act CRM data including Companies, Contact, Groups, Opportunities, and more!