CData Python Connector for ADP

Build 25.0.9454

Establishing a Connection

The objects available within our connector are accessible from the "cdata.adp" module. To use the module's objects directly:

  1. Import the module as follows:
    import cdata.adp as mod
  2. To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
    mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")

Connecting to ADP

Before configuring your connection, ensure you have obtained and formatted your SSL client certificate as described in Before You Connect.

To connect to ADP, set 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: The full file path to your SSL client certificate. If using a .pem file, ensure it contains both the Private Key and Public Certificate. If using a .pfx file, ensure it was created with the correct export password. See Before You Connect for more information.
  • SSLClientCertPassword: The password for the SSL client certificate, if applicable.
  • 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 (default=100). Setting a high value may decrease performance.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454