VOOZH about

URL: https://www.cdata.com/kb/tech/actcrm-cloud-postgres.rst

โ‡ฑ Connect to Live Act CRM Data in PostGresSQL Interface through CData Connect AI


Connect to Live Act CRM Data in PostGresSQL Interface through CData Connect AI

๐Ÿ‘ Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Create a live connection to Act CRM in CData Connect AI and connect to your Act CRM data from PostgreSQL.

There are a vast number of PostgreSQL clients available on the Internet. PostgreSQL is a popular interface for data access. When you pair PostgreSQL with CData Connect AI, you gain database-like access to live Act CRM data from PostgreSQL. In this article, we walk through the process of connecting to Act CRM data in Connect AI and establishing a connection between Connect AI and PostgreSQL using a TDS foreign data wrapper (FDW).

CData Connect AI provides a pure SQL Server interface for Act CRM, allowing you to query data from Act CRM without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Act CRM, leveraging server-side processing to return the requested Act CRM data quickly.

Connect to Act CRM in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. ๐Ÿ‘ Adding a Connection
  3. Select "Act CRM" from the Add Connection panel
  4. ๐Ÿ‘ Selecting a data source
  5. Enter the necessary authentication properties to connect to Act CRM.

    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.

    ๐Ÿ‘ Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add Act CRM Connection page and update the User-based permissions. ๐Ÿ‘ Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. ๐Ÿ‘ Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Act CRM data from PostgreSQL.

Build the TDS Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The tds_fdw extension is used as an example (https://github.com/tds-fdw/tds_fdw).

  1. You can clone and build the git repository via something like the following view source:
    sudo apt-get install git
    git clone https://github.com/tds-fdw/tds_fdw.git
    cd tds_fdw
    make USE_PGXS=1
    sudo make USE_PGXS=1 install
    
    Note: If you have several PostgreSQL versions and you do not want to build for the default one, first locate where the binary for pg_config is, take note of the full path, and then append PG_CONFIG=
  2. After you finish the installation, then start the server:
    sudo service postgresql start
    
  3. Then go inside the Postgres database
    psql -h localhost -U postgres -d postgres
    
    Note: Instead of localhost you can put the IP where your PostgreSQL is hosted.

Connect to Act CRM data as a PostgreSQL Database and query the data!

After you have installed the extension, follow the steps below to start executing queries to Act CRM data:

  1. Log into your database.
  2. Load the extension for the database:
    CREATE EXTENSION tds_fdw;
    
  3. Create a server object for Act CRM data:
    CREATE SERVER "ActCRM1" FOREIGN DATA WRAPPER tds_fdw OPTIONS (servername'tds.cdata.com', port '14333', database 'ActCRM1');
    
  4. Configure user mapping with your email and Personal Access Token from your Connect AI account:
    CREATE USER MAPPING for postgres SERVER "ActCRM1" OPTIONS (username '[email protected]', password 'your_personal_access_token' );
    
  5. Create the local schema:
    CREATE SCHEMA "ActCRM1";
    
  6. Create a foreign table in your local database:
    #Using a table_name definition:
    
    CREATE FOREIGN TABLE "ActCRM1".Activities ( 
    id varchar, 
    Subject varchar) 
    SERVER "ActCRM1"
    OPTIONS(table_name 'ActCRM.Activities', row_estimate_method 'showplan_all');
    
    #Or using a schema_name and table_name definition:
    
    CREATE FOREIGN TABLE "ActCRM1".Activities ( 
    id varchar, 
    Subject varchar) 
    SERVER "ActCRM1"
    OPTIONS (schema_name 'ActCRM', table_name 'Activities', row_estimate_method 'showplan_all');
    
    #Or using a query definition:
    
    CREATE FOREIGN TABLE "ActCRM1".Activities (
    id varchar, 
    Subject varchar) 
    SERVER "ActCRM1"
    OPTIONS (query 'SELECT * FROM ActCRM.Activities', row_estimate_method 'showplan_all');
    
    #Or setting a remote column name:
    
    CREATE FOREIGN TABLE "ActCRM1".Activities (
    id varchar,
    col2 varchar OPTIONS (column_name 'Subject'))
    SERVER "ActCRM1"
    OPTIONS (schema_name 'ActCRM', table_name 'Activities', row_estimate_method 'showplan_all');
    
  7. You can now execute read/write commands to Act CRM:
    SELECT id, Subject
    FROM "ActCRM1".Activities;
    

More Information & Free Trial

Now, you have created a simple query from live Act CRM data. For more information on connecting to Act CRM (and more than 200 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live Act CRM data in PostgreSQL.