ADO.NET Provider for ADP

Build 25.0.9434

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
RowScanDepthSpecifies the number of rows the provider scans to determine data types for custom field columns.
BatchSizeSpecifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 .
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection.
IncludeCustomFieldsA boolean indicating if you would like to include custom fields in the column listing.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreadsSpecifies the maximum number of concurrent threads the provider uses when executing API requests.
OtherSpecifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details.
PageSizeSpecifies the maximum number of records that the provider retrieves per page from ADP.
PoolIdleTimeoutSpecifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool.
PoolMinSizeSpecifies the minimum number of connections to be maintained in the connection pool at all times.
PoolWaitTimeSpecifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ReadonlyToggles read-only access to ADP from the provider.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
TestConnectionEndpointSpecifies the API endpoint that the provider uses to test the connection to ADP.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.
UsePayrollEndpointSpecifies whether the provider uses the Payroll API to retrieve data for payroll-related views.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

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