VOOZH about

URL: https://www.cdata.com/kb/tech/adp-cloud-heidisql.rst

⇱ Connect to ADP Data from HeidiSQL


Connect to ADP Data from HeidiSQL

πŸ‘ Mohsin Turki
Mohsin Turki
Technical Marketing Engineer
Use CData Connect AI to connect to and query live ADP data from HeidiSQL.

HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with CData Connect AI, HediSQL reach extends to include access to live ADP data. This article demonstrates how to connect to ADP using Connect AI and query ADP data in HeidiSQL.

CData Connect AI provides a pure SQL Server interface for ADP, allowing you to query data from ADP 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 ADP, leveraging server-side processing to return the requested ADP data quickly.

Configure ADP Connectivity for HeidiSQL

Connectivity to ADP from HeidiSQL is made possible through CData Connect AI. To work with ADP data from HeidiSQL, we start by creating and configuring a ADP connection.

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

    Connect to ADP by specifying the following properties:

    • OAuthClientId: The client Id of the custom OAuth application you obtained from ADP.
    • OAuthClientSecret: The custom OAuth application's client secret.
    • SSLClientCert: Set this to the certificate provided during registration.
    • SSLClientCertPassword: Set this to the password of the certificate.
    • UseUAT: The connector makes requests to the production environment by default. If using a developer account, set UseUAT = true.
    • RowScanDepth: The maximum number of rows to scan for the custom fields columns available in the table. The default value will be set to 100. Setting a high value may decrease performance.

    The connector uses OAuth to authenticate with ADP. OAuth requires the authenticating user to interact with ADP using the browser. OAuth access can be configured in ADP through ADP API Central. For more information, refer ADP's API Central Quick Start Guide and the OAuth section in CData's Help documentation.

    πŸ‘ Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add ADP 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 ADP data from HeidiSQL.

Connect to ADP from HeidiSQL using Connect AI

To establish a connection from HeidiSQL to the CData Connect AI Virtual SQL Server API, follow these steps.

Create a new HeidiSQL Session

  1. In the Session Manager, select New in the bottom-left
  2. Give the new session a descriptive name, e.g. Connect-Cloud-ADP
  3. πŸ‘ Creating a new session in HeidiSQL.

Configure a SQL Server Connection to Connect AI

  1. In the session settings, set the Network type to Microsoft SQL Server (TCP/IP)
  2. The Library DLL should automatically update to MSOLEDBSQL
  3. Set the Hostname/IP to tds.cdata.com
  4. Set the User to your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected]
  5. Set the Password to your PAT created in Connect AI in the previous section.
  6. Set the Port to 14333 πŸ‘ Configuring a SQL Server connection to Connect AI

Query ADP from HeidiSQL

  1. In the database listing on the left, find your connection to ADP configured earlier.
  2. Expand this connection to view individual tables or data objects present within ADP.
  3. Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables πŸ‘ Querying within HeidiSQL.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect AI today!