Getting Started

Connecting to ADP

For information on the available WHL files for supported environments, and how to install the appropriate file for your Python distribution, see Package Installation.

For information on the module to import, and how to configure the necessary connection properties in a connection string, see Establishing a Connection.

Other available connection properties can be used to configure other aspects of the connector capabilities.

Python Version Support

The CData Python Connector for ADP can be installed and used in Python 3.10 or newer.

ADP Version Support

The connector leverages the following ADP APIs to enable access to ADP Workforce Now data:

Applicant Onboard V2 API
Payroll Data Input API
Payroll Output API
Team Time Cards API
Time Cards API
Time Off Balances API
Time Off Request API
Validation Table Code List API
Work Assignment API
Work Assignment API
Work Schedules API
Worker Management API
Workers API

Before You Connect

Before you can establish a connection, you must you must complete two key prerequisites:

Obtain a custom OAuth application and its associated credentials from ADP.
Generate a client certificate for Mutual SSL Authentication.

ADP requires Mutual SSL Authentication, meaning you must provide a client certificate for authentication. This certificate consists of:

A Private Key to sign authentication requests.
A Public Certificate issued by ADP to verify requests.

Mutual SSL helps establish a secure, trusted connection by requiring both parties to exchange certificates and verify each other's identities. Since ADP issues these files separately, you must retrieve both before configuring your connection.

For more details, see ADP Developer Resources.

You can retrieve these files using one of three methods, depending on how your organization purchased ADP APIs:

ADP Partners: Automated process through the Developer Self-Service Portal.
ADP Clients: Manual Certificate Signing Request (CSR) generation and submission through the ADP Certificate Signing Tool.
ADP API Central users: Automated process through API Central.

Regardless of the retrieval method, you must combine the Private Key and Public Certificate into a single PFX or PEM file before configuring your connection.

Important Security Note: Your Private Key and combined certificate files (PFX or PEM) are sensitive credentials. Store them securely, and do not share them. Anyone with access to these files could impersonate your application.

Common mistakes to avoid:

Attempting to retrieve the Private Key after generation. It can only be copied once.
Using an incorrect organization name when creating the certificate. This name must match the organization name registered with ADP.
Failing to combine the Private Key and Public Certificate into a supported format. The connection will fail if this step is skipped.
Allowing certificates to expire. ADP sends a renewal notice 60 days before expiration.

Note: If you are manually generating a CSR, you must submit the CSR to ADP and download the signed certificate before combining it with your private key. For more information, see ADP Developer Resources.

Retrieving Your SSL Certificate from the Developer Self-Service Portal

To retrieve your SSL certificate, follow these steps:

Log in to the ADP Developer Self-Service Portal using your Partner Developer Account.
Navigate to the Certificate section.
Click Request Certificate.
Complete the required fields and click Next.
On the next screen, click Copy to save your Private Key (.key file).
After copying the key, click Ok, I copied my key.
Click Done, then download your Public Certificate (.pem file).

Important: The Private Key file is only available at the time of generation. You must copy and store it securely, as you are not be able to retrieve it again later.

Your certificate is valid for two years. ADP will send a renewal notification 60 days before expiration.

Retrieving Your SSL Certificate with the Manual CSR Process

If your organization uses the manual Certificate Signing Request process:

Follow the instructions in the ADP Certificate Signing Tool to generate your CSR and private key.
Submit the CSR and download the signed certificate from ADP once it's approved.
Proceed to combine the private key and public certificate into a PFX or PEM file as described below.

Retrieving Your SSL Certificate from API Central

If your organization uses API Central:

Log in to API Central and navigate to your project.
Select Certificate from the menu or from Step 1 of the project setup.
Follow the guided process to generate and download your Private Key and Public Certificate.
Store the private key securely.

After retrieving both files, proceed to combine them into a supported format.

Combining the Private Key and Public Certificate

Before using the certificate, you must combine the Private Key and Public Certificate into a single file format that the connector supports. If your organization uses ADP API Central, this manual combination process may not be required.

Option 1: Create a PFX File (Default)

If using the default setting for the SSLClientCertType property (PFXFILE), convert your Private Key and Public Certificate into a .pfx file.

Run the following command in OpenSSL:
```
openssl pkcs12 -export -out adp.pfx -name "<OrgName> Mutual SSL" -inkey <your-private-key>.key -in <your-public-certificate>.pem
```
Replace "<OrgName>" with your organization name. This string must match exactly the organization name used when registering with ADP and appears during certificate generation in the Developer Self-Service Portal.

Next, replace "<your-private-key>.key" and "<your-public-certificate>.pem" with the actual file paths to your SSL private key and certificate.
When prompted, enter an export password. Use this password as the value for the SSLClientCertPassword property, and use the full file path of the generated .pfx file as the value for the SSLClientCert property when configuring the connection.

Using a Base64-Encoded PFX File (PFXBLOB)

If using the PFXBLOB type, you must convert the .pfx file into a Base64 string before using it in the connection settings.

Run the following command to encode the .pfx file:
```
openssl base64 -in adp.pfx -out adp_base64.txt
```
Copy the entire contents of adp_base64.txt into the SSLClientCert property when configuring the connection.

Option 2: Create a PEM File (PEMKEY_FILE or PEMKEY_BLOB)

If using the PEMKEY_FILE or PEMKEY_BLOB certificate type, follow one of the methods below to combine your Private Key and Public Certificate into a single PEM-formatted file.

You can do this manually by opening both privateKey.key and publicCert.pem in a text editor:

Copy the Private Key contents.
Paste the Public Certificate contents directly below the Private Key in the same file.
Save the file as combined_cert.pem.

Alternatively, for Linux users, run the following command in a terminal from the directory where your Private Key and Public Certificate files are stored:

cat privateKey.key publicCert.pem > combined_cert.pem

If using PEMKEY_FILE, set the full file path of combined_cert.pem as the value for the SSLClientCert property when configuring the connection.

If using PEMKEY_BLOB, you have two options:

Open combined_cert.pem in a text editor and copy the entire contents directly into the SSLClientCert property.
Or, encode the file as Base64 using the following command, and copy the output into the property:
```
openssl base64 -in combined_cert.pem -out cert_base64.txt
```

Then, copy the full Base64 string from cert_base64.txt into the SSLClientCert property.

Package Installation

Dependencies

The Python connectors require that Python 3.10 or newer be installed.

Installation

The CData Python Connector for ADP is available as a WHL file for Windows, Linux, and Mac. Each connector is built using the Python 3.10 Stable ABI (indicated by the abi3 tag in the filename), so a single wheel supports any Python 3.10 or newer installation — there is no need to match your exact Python minor version. Use the "pip install" command with the appropriate WHL file for your platform.

Windows:

pip install cdata_adp_connector-26.0.9655-cp310-abi3-win_amd64.whl

Linux:

pip install cdata_adp_connector-26.0.9655-cp310-abi3-linux_x86_64.whl

macOS:

pip install cdata_adp_connector-26.0.9655-cp310-abi3-macosx_12_0_arm64.whl

The macOS wheel supports arm64 (Apple Silicon) architectures only on macOS 12 and newer.

Regardless of the environment, certain distributions might require that the "pip3 install" command be used instead, to differentiate from a Python 2 distribution that might exist already. After installation, confirm whether the connector is successfully installed by running the "pip list" command. If "cdata_adp_connector" is present in the list output by the command, then the installation was successful.

Upgrading

When upgrading, "pip install" does not automatically clean up old JRE files. To avoid leftover files that could cause JVM errors, uninstall the previous version before installing the new one.

Licensing

After the installation is complete, a separate step is needed to activate a license for the connector. Among the CData assets in the distribution's site packages, there is an install-license tool that activates this license. From within the distribution's site-packages folder, after navigating to the "cdata/installlic_adp" folder, simply use a command like the below to activate the license. Omitting the <key> argument activates a trial license:

Windows:
```
./install-license.exe <key>
```
Linux / Mac:
```
./install-license.sh <key>
```

Sometimes, file access issues may cause pip to install the connector in a fallback file path that is not the python distribution's main or primary site-packages location. This can make it difficult to find where the connector was installed, and from there, the license activator. In that event, this python script below will print out the full file path of the connector's native file. This file will be stored in the mentioned cdata folder, from which the installlic_adp folder is trivial to find:

import os
import cdata.adp
path = os.path.abspath(cdata.adp.__file__)
print(path)

Uninstallation

If the connector needs to be uninstalled for any reason, do so by running the pip uninstall command, as in the example below:

pip uninstall cdata-adp-connector

Establishing a Connection

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

Import the module as follows:
```
import cdata.adp as mod
```

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.

Configuring JNI

Java Native Interface (JNI) is a standard programming interface for writing Java native methods and embedding the Java virtual machine into native applications.

The connector leverages the JNI for improved performance on Mac and Linux.

Configure the Config INI File

The Linux and Mac editions of the ADP python connector are configured with an ini file. This file is used to set several parameters, including JNI behavior. This file is to be located in:

{path_to_distribution_site-packages}/cdata/config.ini

Ensure that any configuration properties you set in the ini file fall under the following section name (adjust the 311 number if you are using an different python version from 3.11):

For Linux:
```
[adp.cpython-311-x86_64-linux-gnu.so]
```
For Mac:
```
[adp.cpython-311-darwin.so]
```

Configure the JNI connector's behavior by editing the properties in the connector's config.ini file. The connector can be configured as follows:

LOGFILE: Set this the same way as the CDATA_LOGFILE envrionment variable below.
JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
CLASS_PATH: Use a colon-separated list to configure the paths to the third-party jar libraries.

Configure Environment Variables

Additionally, set the following environment variables:

CDATA_JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
CDATA_JVM_OPTIONS: Place JVM options here.
CDATA_LOGFILE: Set this in the following scheme: <SCHEME>://<TAG>[|<LEVEL>]
- SCHEME: The options are STDOUT, FILE.
  - STDOUT: Both the native wrapper and odbc core log into stdout. The Logfile and Verbosity properties can override the behavior of ODBC core.
  - FILE: The native wrapper logs into <FILENAME> while the odbc core logs into <FILENAME>.driver.log. The Logfile and Verbosity properties can override the behavior of ODBC core.
- TAG
  - For STDOUT, set this to 1. For FILE, set this to the filename.
- LEVEL
  - Set to one of: FATAL | ERROR | WARNING | INFO | DEBUG

The following are some examples of this syntax:

STDOUT://1|DEBUG
FILE:///tmp/my_py.log|DEBUG

Custom Logger

The Python connector supports a custom logging mechanism for redirecting log output to any destination, such as a cloud storage service or logging framework. Use setCustomLoggerFactory() to register a factory function that creates a logger instance for each connection.

The factory function receives the context string from the Logfile connection property (the portion after CUSTOM://) and must return an object with a writeLog(verbosity, message) method.

To enable custom logging:

Call setCustomLoggerFactory() with your factory function before opening connections.
Set Logfile to CUSTOM:// followed by a context string to identify the connection.
Set Verbosity to the desired log level.

The following example demonstrates a custom logger factory that creates a separate logger instance per connection:

import cdata.adp as mod
import time

class MyLogger:
    def __init__(self, loggerId):
        self.loggerId = loggerId
    def writeLog(self, verbosity, message):
        print("[MyLogger " + self.loggerId + "] " + message)

def createLogger(context):
    return MyLogger(context[len("MyLoggerId="):])

mod.setCustomLoggerFactory(createLogger)

conn1 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=1;Verbosity=2;")
# do something with conn1
time.sleep(1)  # Wait for logs to flush from conn1

conn2 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=2;Verbosity=2;")
# do something with conn2
time.sleep(1)  # Wait for logs to flush from conn2

Changelog

General Changes


Date	Version	Source	Category	Type	Description
2026-05-28	26.0.9644	ADP	Metadata	Changed	Changed the data type of the PageSize connection property from string to integer.
2026-05-27	26.0.9643	General	Connection	Removed	Removed the deprecated ReplaceInvalidTypesWithNull connection property. Use the ReplaceInvalidValuesWithNull property instead.
2026-05-22	26.0.9638	Python		Removed	Remove support for Intel x64 architecture on macOS
2026-05-07	26.0.9623	General	Data Model	Added	Added the ColumnCapabilities column to the sys_tablecolumns system table. This column is a bit mask denoting the column's write capabilities.
2026-05-07	26.0.9623	Python		Changed	Updated embedded JRE to jre-17.0.19+10 (Linux x64 / MacOs x64).
2026-04-15	26.0.9601	General	Query Exec	Changed	String comparisons using GREATER, LESS, and CONTAINS operators are now case-insensitive by default.
2026-04-08	26.0.9594	ADP	Security	Changed	TLS 1.3 is now supported by default for HTTP connections.
2026-03-31	26.0.9586	ADP	Data Model	Changed	Changed the EventId input parameter to MsgId in the DeleteEventMessage stored procedure.
2026-03-23	25.0.9578	ADP	Data Model	Added	Added the MsgId output parameter to the GetEventMessage stored procedure.
2026-01-20	25.0.9516	ADP		Added	Added the BenefitCoverages view.
2026-01-13	25.0.9509	General		Added	Added support for the REGEXP_REPLACE() string function.
2026-01-07	25.0.9503	ADP		Added	Added support for the WorkerLeaves view.
2025-12-21	25.0.9486	Python		Added	Added support for custom loggers in Python connectors on Linux and macOS.
2025-12-05	25.0.9470	General		Added	Added support for the INSERT INTO SELECT statement, with driver-side execution for providers that do not support the operation natively.
2025-10-30	25.0.9434	Python		Changed	Updated embedded JRE to jre-17.0.17+10 (Linux x64 / MacOs x64).
2025-10-06	25.0.9410	General		Added	Support for parsing datetime formats using ".S" and ",S" for milliseconds and nanoseconds.
2025-09-12	25.0.9386	General		Added	Added the IsInsertable, IsUpdateable, and IsDeleteable columns to the sys_tables table.
2025-09-10	25.0.9384	General		Changed	All columns in statically defined Views are now reported as read-only.
2025-09-03	25.0.9377	General		Changed	Corrected the behavior when IN criteria with NULL values are used in the projection part. It now returns NULL instead of 0. For example, "NULL IN (1,2)" returns "NULL".
2025-09-01	25.0.9375	General		Added	Added support for using the CAST function with infinity values. This function can cast "inf" and "-inf" to DOUBLE, FLOAT, or REAL.
2025-08-21	25.0.9364	General		Changed	Report behavior change: Fixed inconsistent string value comparisons in non-table queries. For example, "SELECT 'A' = 'a'" previously returned false, but it now returns true.
2025-08-13	25.0.9356	General		Changed	Changed the maximum number of pages held in memory from 15 to 5 for the page providers to decrease heap usage.
2025-07-25	25.0.9337	ADP		Added	Added the GetEventMessage and DeleteEventMessage stored procedures.
2025-07-07	25.0.9319	Python		Removed	Removed the 32-bit version of Windows Python.
2025-07-02	25.0.9314	Python		Removed	Removed support for Python 3.9.
2025-06-25	25.0.9307	General		Removed	Removed the "ADLS Gen 1" value from the ConnectionType property.
2025-06-25	25.0.9307	Python		Added	Added support for Python 3.13 in Windows, Linux, and Mac editions.
2025-06-25	25.0.9307	Python		Removed	Removed support for Python 3.8 as it is no longer supported.
2025-06-20	25.0.9302	General		Added	Created the following functions: TEXT_ENCODE: encodes a string into a different charset (UTF8 → UTF7 and returns a binary array as the result). TEXT_DECODE: takes a binary array and decodes it back into a string when provided the charset. BASE64_ENCODE: takes a binary array and encodes it as a base64 string (varchar). BASE64_DECODE: takes a base 64-encoded string and decodes it into a binary array.
2025-06-18	25.0.9300	General		Changed	The internal code for exception handling has been refactored. Exception messages returned during certain error conditions may now have different wording or formatting.
2025-05-27	25.0.9278	General		Removed	Removed the "Proprietary" enum option from ProxyAuthscheme.
2025-05-12	25.0.9263	Python		Changed	Updated embedded JRE to jre-17.0.15+6 (Linux x64 / MacOS x64) and jre-17.0.15+6 (MacOS aarch64).
2025-02-15	24.0.9177	General		Added	Added support for converting unsigned integer types to the nearest signed data type that has enough precision to hold the unsigned value.This is done for JDBC only because it does not have support for unsigned data types.
2024-11-27	24.0.9097	General		Added	Added ThreadId to LogModule output. Logfile lines now include the Thread ID associated with the action being performed.
2024-06-05	24.0.8922	Python		Added	Added support for Python 3.12.
2024-05-09	24.0.8895	General		Changed	The ROUND function previously did not accept negative precision values. That feature has now been restored.
2024-03-15	23.0.8840	General		Added	Created a new SQL function called STRING_COMPARE that provides java's String.compare() ability to SQL queries. Returns a number representative of the compared value of two strings
2023-11-29	23.0.8733	General		Changed	The ROUND function doesn't accept the negative precision values anymore.
2023-11-29	23.0.8733	General		Changed	The returning types of the FDMonth, FDQuarter, FDWeek, LDMonth, LDQuarter, LDWeek functions are changed from Timestamp to Date. The return type of the ABS function will be consistent with the parameter value type.
2023-11-28	23.0.8732	General		Added	Added the HMACSHA256 formatter to allow for secrets to be decoded if it is in base64 format
2023-11-13	23.0.8717	ADP		Added	Added ItemID as composite key to WorkersWorkAssignments table.
2023-10-27	23.0.8700	ADP		Added	Added paging support to the TeamTimeCards, TeamTimeCardsDailyTotals, TeamTimeCardsHomeLaborAllocations, TeamTimeCardsPeriodTotals view.
2023-10-05	23.0.8678	ADP		Added	Added ManagerOID column to the TeamTimeCards, TeamTimeCardsDailyTotals, TeamTimeCardsHomeLaborAllocations, and TeamTimeCardsPeriodTotals views.
2023-10-05	23.0.8678	ADP		Changed	The driver now treats AssociateOID as a Non-Filterable column since the API now supports filtering on the ManagerOID column only.
2023-08-29	23.0.8641	Python		Added	Added support for SQLAlchemy 2.0.
2023-08-07	23.0.8619	ADP		Added	Added DayEntries aggregates column to the TeamTimeCardsDailyTotals view.
2023-07-18	23.0.8599	ADP		Added	Added HomeLaborAllocations aggregates column to the TeamTimeCardsDailyTotals view.
2023-06-20	23.0.8571	General		Added	Added the new sys_lastresultinfo system table.
2023-06-15	23.0.8566	ADP		Added	Added MaskSensitiveData connection property to get masked sensitive data from the ADP.
2023-05-19	23.0.8539	Python		Added	Added support for Python 3.11 on Windows, Linux and Mac.
2023-05-17	23.0.8537	ADP		Added	Added WorkerDemographics view.
2023-05-16	23.0.8536	Python		Removed	Removed support for Python 3.7 on Windows and Linux
2023-04-25	23.0.8515	General		Removed	Removed support for the SELECT INTO CSV statement. The core code doesn't support it anymore.
2022-12-22	22.0.8391	ADP		Added	Added CostCenters view .
2022-12-14	22.0.8383	General		Changed	Added the Default column to the sys_procedureparameters table.
2022-11-15	22.0.8354	Python		Changed	Updated embedded JRE to jre8u345-b01(Linux x64 / MacOS x64) and jre-17.0.5+8(MacOS aarch64).
2022-09-30	22.0.8308	General		Changed	Added the IsPath column to the sys_procedureparameters table.
2022-05-24	22.0.8179	ADP		Added	Added UsePayrollEndpoint Connection String Property to fetch data for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using UsePayrollEndpoint. Setting it to true may affect the performance of the views.
2022-05-18	22.0.8173	Python		Added	Added support for Python 3.10 on Windows, Linux, and Mac Added support for Python 3.9 on Mac Added support for Mac M1
2022-05-18	22.0.8173	Python		Removed	Removed support for Python 3.6 on Windows and Linux
2022-03-29	21.0.8123	ADP		Added	Added the OAuthExpiresIn and OAuthTimestamp connection properties.
2022-03-25	21.0.8119	ADP		Added	Added support for the IN operation when filtering data for views where ItemID or AssociateOID is required.
2022-03-21	21.0.8115	ADP		Added	Added the DepartmentId column to the following views: AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryNonStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations and AssociatePaymentsSummaryStatutoryDeductions.
2022-02-09	21.0.8075	ADP		Added	Added support for the WorkAssignmentHistory view, and associated views including: WorkAssignmentCustomHistoryCustomGroupAmountFields, WorkAssignmentCustomHistoryCustomGroupCodeFields, WorkAssignmentCustomHistoryCustomGroupDateFields, WorkAssignmentCustomHistoryCustomGroupDateTimeFields, WorkAssignmentCustomHistoryCustomGroupIndicatorFields, WorkAssignmentCustomHistoryCustomGroupGroupLinks, WorkAssignmentCustomHistoryCustomGroupNumberFields, WorkAssignmentCustomHistoryCustomGroupPercentFields, WorkAssignmentCustomHistoryCustomGroupStringFields, WorkAssignmentCustomHistoryCustomGroupTelephoneFields, WorkAssignmentHistoryAdditionalRemunerations, WorkAssignmentHistoryAssignedOrganizationUnits, WorkAssignmentHistoryAssignedWorkLocations, WorkAssignmentHistoryCommunicationsEmails, WorkAssignmentHistoryFaxes, WorkAssignmentHistoryInstantMessages, WorkAssignmentHistoryInternetAddresses, WorkAssignmentHistoryCommunicationsLandLines, WorkAssignmentHistoryCommunicationsMobiles, WorkAssignmentHistoryCommunicationsPagers, WorkAssignmentHistoryCommunicationsSocialNetworks, WorkAssignmentHistoryHomeOrganizationUnits, WorkAssignmentIndustryClassifications, WorkAssignmentHistoryReport, WorkAssignmentHistoryWorkerGroups.
2022-01-31	21.0.8066	ADP		Added	Added the TimeCards, TimeCardsDailyTotals, TimeCardsPeriodTotals, TeamTimeCards, TeamTimeCardsDailyTotals, TeamTimeCardsPeriodTotals, TeamTimeCardsHomeLaborAllocations, WorkSchedules, WorkSchedulesEntries views.
2021-12-13	21.0.8017	ADP		Added	Added the AssociatePayments column to the PayrollRuns table.
2021-09-02	21.0.7915	General		Added	Added support for the STRING_SPLIT table-valued function in the CROSS APPLY clause.
2021-08-07	21.0.7889	General		Changed	Added the KeySeq column to the sys_foreignkeys table.
2021-08-06	21.0.7888	General		Changed	Added the new sys_primarykeys system table.
2021-07-23	21.0.7874	General		Changed	Updated the Literal Function Names for relative date/datetime functions. Previously, relative date/datetime functions resolved to a different value when used in the projection as opposed to the predicate. For example: SELECT LAST_MONTH() AS lm, Col FROM Table WHERE Col > LAST_MONTH(). Formerly, the two LAST_MONTH() methods would resolve to different datetimes. Now, they will match. As a replacement for the previous behavior, the relative date/datetime functions in the criteria may have an 'L' appended to them. For example: WHERE col > L_LAST_MONTH(). This will continue to resolve to the same values that were previously calculated in the criteria. Note that the "L_" prefix will only work in the predicate - it not available for the projection.
2021-04-25	21.0.7785	General		Added	Added support for handling client side formulas during insert / update. For example: UPDATE Table SET Col1 = CONCAT(Col1, " - ", Col2) WHERE Col2 LIKE 'A%'
2021-04-23	21.0.7783	General		Changed	Updated how display sizes are determined for varchar primary key and foreign key columns so they will match the reported length of the column.
2021-04-16	21.0.7776	General		Added	Non-conditional updates between two columns is now available to all drivers. For example: UPDATE Table SET Col1=Col2
2021-04-16	21.0.7776	General		Changed	Reduced the length to 255 for varchar primary key and foreign key columns.
2021-04-16	21.0.7776	General		Changed	Updated implicit and metadata caching to improve performance and support for multiple connections. Old metadata caches are not compatible - you need to generate new metadata caches if you are currently using CacheMetadata.
2021-04-16	21.0.7776	General		Changed	Updated index naming convention to avoid duplicates.

Using the Connector

This section provides a walk-through for writing ADP data access code in Python script.

For more information on the available data source entities and how to query them with SQL, see Data Model. For the SQL syntax, see SQL Compliance.

Connecting from Code

For information on how to deploy the connector and configure the connection to ADP, see Package Installation and Establishing a Connection.

For information on how to connect with the adp.connector module and its related classes, see Connecting.

Executing SQL

The connection's cursor object is used to directly execute SQL queries. For information on how to execute SELECT statements and process the returned result sets, see Querying Data. For information on to modify the data in ADP with INSERT, UPDATE, and DELETE statements, see Modifying Data .

Executing Stored Procedures

You can call stored procedures by using the EXECUTE statement. For further information, see Calling Stored Procedures.

Batch Processing

For information about how to modify several rows of ADP data at once using parameterized INSERT, UPDATE, and DELETE statements, see Batch Processing.

Connecting

Connecting with the cdata.adp Module:

The connector's module is used directly to establish a connection with the data source. It does this by using a connection string as its argument. For example:

import cdata.adp as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")

Once the connection is created, you can use it to execute subsequent SQL queries.

Querying Data

After connecting as described in Connecting, you can use the open connection to execute SQL statements.

Executing Queries

To execute SQL statements that return data, use the execute() method. Once a query is executed, the result set is fetched from the cursor. This result set can then be iterated over to process the records individually.

For example:

cur = conn.execute("SELECT AssociateOID, WorkerID FROM Workers")
rs = cur.fetchall()
for row in rs:
	print(row)

Parameterized Queries

Various Python collections, such as arrays and tuples, can act as additional arguments for the execute() method. This enables you to parameterize the queries executed and help to prevent SQL Injection.

For example:

cmd = "SELECT AssociateOID, WorkerID FROM Workers WHERE AssociateOID = ?"
params = ["G3349PZGBADQY8H8"]
cur = conn.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

Modifying Data

The connection is also used to issue INSERT, UPDATE, and DELETE commands to the data source. Parameters can be used with these statements if desired.

Note that the connector does not support transactions. As with normal write operations, all SQL statements executed by this connector affect the data source immediately. Call the connection's commit() method following the execution.

Insert

The following example adds a new record to the table:

cmd = "INSERT INTO Workers (AssociateOID, WorkerID) VALUES (?, ?)"
params = ["Jon Doe", "John"]
cur = conn.execute(cmd, params)
print("Records affected: ", cur.rowcount)

Update

The following example modifies an existing record in the table:

cmd = "UPDATE Workers SET WorkerID = ? WHERE Id = ?"
params = ["John", "6"]
cur = conn.execute(cmd, params)
print("Records affected: ", cur.rowcount)

Delete

The following example removes an existing record from the table:

cmd = "DELETE FROM Workers WHERE Id = ?"
params = ["6"]
cur = conn.execute(cmd, params)
print("Records affected: ", cur.rowcount)

Calling Stored Procedures

You can execute stored procedures using either the execute() or callproc() method of the connection.

Calling Stored Procedures Using Execute()

When you call stored procedures by issuing EXECUTE commands, the stored procedure arguments are parameterized. For example:

cmd = "EXECUTE SelectEntries ObjectName = ?"
params = ["Account"]
conn.execute(cmd, params)

Calling Stored Procedures Using Callproc()

When you call stored procedured by issuing the callproc() method, the stored procedure arguments are a procedure name and a list of parameters. For example:

cur = conn.cursor()
params = ["Account"]
cur.callproc("SelectEntries", params)

Batch Processing

This Python connector also supports writing to the data source via batch processing, using the cursor object's executemany() method. This requires both a SQL statement string and a data frame of values that act as a series of parameters for executing the SQL statement.

Note that the connector does not support transactions. As with normal write operations, all SQL statements executed by this connector affect the data source immediately. Call the connection's commit() method following the execution.

Insert

The following example adds new records to the table:

cur = conn.cursor()
cmd = "INSERT INTO Workers (AssociateOID, WorkerID) VALUES (?, ?)"
params = [["Jon Doe", "John"], ["Jon Doe", "John"]]
cur.executemany(cmd, params)
print("Records affected: ", cur.rowcount)

Using from Tools

The connector is integrated with other tools and packages within Python.

Python Integration Guides

The following sections show how to create and use connections with the connector in common packages in Python:

From SQLAlchemy
From Pandas
From Matplotlib
From Petl

Complete List of ADP Integration Quickstarts

For information on connecting from other applications, see ADP integration guides.

From SQLAlchemy

The CData Python Connector for ADP includes a Dialect class that enables integration with SQLAlchemy. Bear in mind that several aspects of connector functionality are not currently supported in SQLAlchemy 2.0 or above. If necessary, downgrade SQLAlchemy to version 1.4 or 1.3 before using this connector.

The following sections detail various aspects of this integration:

Connecting From SQLAlchemy

To construct a URL with which SQLAlchemy loads and uses the appropriate connector automatically, see Connecting

Reflecting Metadata With SQLAlchemy

To learn how to model ADP tables with mapped classes, see Reflecting Metadata.

Querying Data From SQLAlchemy

To learn how to use mapped classes to query the associated tables, see Querying Data.

Modifying Data From SQLAlchemy

The connector provides INSERT/UPDATE/DELETE functionality in SQLAlchemy. To learn how to call the session's execute() method to affect the data in the data source, see Modifying Data.

Connecting

Connecting With a Dialect URL

Establishing a connection using SQLAlchemy requires a specific URL format.

from sqlalchemy import create_engine
engine = create_engine("adp:///?InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")

For SQLAlchemy 2.0, the dialect name is adp_2. To establish a connection, use the following URL format:

from sqlalchemy import create_engine
engine = create_engine("adp_2:///?InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")

Reflecting Metadata

SQLAlchemy can act as an Object-relational Map (ORM). This enables you to treat records of a database table as instantiable records. To leverage this functionality, you must reflect the underlying metadata in one of the following ways.

Note: The following examples employ SQLAlchemy 1.4.

Modeling Data Using a Mapping Class

Use "sqlalchemy.ext.declarative.declarative_base" to declare a mapping class for the table you wish to model in the ORM. A known table in the data model is modeled either partially or completely, as shown in the following example:

from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class Workers(Base):
	__tablename__ = "Workers"
	Id = Column(String, primary_key=True)
	AssociateOID = Column(String)
	WorkerID = Column(String)

Automatically Reflecting Metadata

Rather than mapping tables manually, SQLAlchemy can discover the metadata for one or more tables automatically. To accomplish this across the entire data model, use automap_base:

from sqlalchemy import MetaData
from sqlalchemy.ext.automap import automap_base
meta = MetaData()
abase = automap_base(metadata=meta)
abase.prepare(autoload_with=engine)
Workers = abase.classes.Workers

You can also reflect a single table with an inspector. When reflecting this way, providing a list of specific columns to map is optional:

from sqlalchemy import MetaData, Table
from sqlalchemy import inspect
meta = MetaData()
insp = inspect(engine)
Workers_table = Table("Workers", meta)
insp.reflect_table(Workers_table, ["Id","WorkerID"])

Querying Data

After you use the steps in Connecting to connect, and use one of the methods in Reflecting Metadata to reflect some of the metadata, you can use a session object to query data.

Querying Data Using the Query Method

If the mapping class has been prepared, use it with a session object to query the data source. After binding the engine to the session, provide the mapping class to the session's query method.

For example:

engine = create_engine("adp:///?InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Workers).filter_by(AssociateOID="G3349PZGBADQY8H8"):
	print("Id: ", instance.Id)
	print("AssociateOID: ", instance.AssociateOID)
	print("WorkerID: ", instance.WorkerID)
	print("---------")

Querying Data Using the Execute Method

The session object can also run the query with the execute() method alongside the appropriate Table object. Assuming you have an active session, the following is just as viable:

Workers_table = Workers.metadata.tables["Workers"]
for instance in session.execute(Workers_table.select().where(Workers_table.c.AssociateOID == "G3349PZGBADQY8H8")):
	print("Id: ", instance.Id)
	print("FullName: ", instance.Name)
	print("City: ", instance.BillingCity)
	print("---------")

Executing JOINs

Implicit Joining

If mapped classes of related ADP objects have a singular foreign key relationship, the classes are implicitly joined. After importing the necessary objects, a relationship is established between your two mapped classes, as in the example below:

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, String, Integer, DateTime, ForeignKey
from sqlalchemy.orm import sessionmaker, relationship

Base = declarative_base()
class Contact(Base):
	__tablename__ = "Contact"
	Id = Column(Integer, primary_key=True)
	Name = Column(String)
	Email = Column(String)
	BirthDate = Column(DateTime)
	AccountId = Column(String, ForeignKey("Account.Id"))
	Account_Link = relationship("Account", back_populates="Contact_Link")

class Account(Base):
	__tablename__ = "Account"
	Id = Column(String, primary_key=True)
	Name = Column(String)
	BillingCity = Column(String)
	NumberOfEmployees = Column(Integer)
	Contact_Link = relationship("Contact", order_by=Contact.Id, back_populates="Account_Link")

Once the relationship is established, the tables are queried simultaneously using the session's query() method. For example:

rs = session.query(Account, Contact).filter(Account.Id == Contact.AccountId)
for Ac, Ct in rs:
  print("AccountId: ", Ac.Id)
  print("AccountName: ", Ac.Name)
  print("ContactId: ", Ct.Id)
  print("ContactName: ", Ct.Name)

Other Join Forms

In situations where mapped classes have either no foreign keys or multiple foreign keys, you may need different forms of the JOIN query to accommodate them. Using the earlier classes as examples, the following JOIN queries are possible as well:

Explicit condition (necessary if there are no foreign keys in your mapped classes):

rs = session.query(Account, Contact).join(Contact, Account.Id == Contact.AccountId)
for Ac, Ct in rs:

Left-to-right relationship:

rs = session.query(Account, Contact).join(Account.Contact_Link)
for Ac, Ct in rs:

Left-to-right relationship with explicit target:

rs = session.query(Account, Contact).join(Contact, Account.Contact_Link)
for Ac, Ct in rs:

String form of a left-to-right relationship:

rs = session.query(Account, Contact).join("Contact_Link")
for Ac, Ct in rs:

Other SQL Clauses

SQLAlchemy ORM also exposes support for other clauses in SQL, such as ORDER BY, GROUP BY, LIMIT, and OFFSET. All of these are supported by this connector:

ORDER BY

The following example sorts by a specified column using the session object's query() method:

rs = session.query(Workers).order_by(Workers.AnnualRevenue)
for instance in rs:
	print("Id: ", instance.Id)
	print("AssociateOID: ", instance.AssociateOID)
	print("WorkerID: ", instance.WorkerID)
	print("---------")

You can also use the session object's execute() method perform an ORDER BY. For example:

rs = session.execute(Workers_table.select().order_by(Workers_table.c.AnnualRevenue))
for instance in rs:

GROUP BY

The following example uses the session object's query() method to group records with a specified column:

rs = session.query(func.count(Workers.Id).label("CustomCount"), Workers.AssociateOID).group_by(Workers.AssociateOID)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("AssociateOID: ", instance.AssociateOID)
	print("---------")

You can also use the session object's execute() method to perform a GROUP BY:

rs = session.execute(Workers_table.select().with_only_columns([func.count(Workers_table.c.Id).label("CustomCount"), Workers_table.c.AssociateOID]).group_by(Workers_table.c.AssociateOID))
for instance in rs:

LIMIT and OFFSET

The following example uses the session object's query() method to skip the first 100 records and fetch the following 25:

rs = session.query(Workers).limit(25).offset(100)
for instance in rs:
	print("Id: ", instance.Id)
	print("AssociateOID: ", instance.AssociateOID)
	print("WorkerID: ", instance.WorkerID)
	print("---------")

You can also use the session object's execute() method to set a LIMIT or OFFSET:

rs = session.execute(Workers_table.select().limit(25).offset(100))
for instance in rs:

Aggregate Functions

Certain aggregate functions can also be used within SQLAlchemy by using the func module.

To import this module, execute:

from sqlalchemy.sql import func

Once func is imported, the following aggregate functions are available:

COUNT

The following example counts the number of records in a set of groups using the session object's query() method.

rs = session.query(func.count(Workers.Id).label("CustomCount"), Workers.AssociateOID).group_by(Workers.AssociateOID)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("AssociateOID: ", instance.AssociateOID)
	print("---------")

You can also execute COUNT using the session object's execute() method:

rs = session.execute(Workers_table.select().with_only_columns([func.count(Workers_table.c.Id).label("CustomCount"), Workers_table.c.AssociateOID])group_by(Workers_table.c.AssociateOID))
for instance in rs:

SUM

This example calculates the cumulative amount of a numeric column in a set of groups.

rs = session.query(func.sum(Workers.AnnualRevenue).label("CustomSum"), Workers.AssociateOID).group_by(Workers.AssociateOID)
for instance in rs:
	print("Sum: ", instance.CustomSum)
	print("AssociateOID: ", instance.AssociateOID)
	print("---------")

You can also invoke SUM using the session object's execute() method.

rs = session.execute(Workers_table.select().with_only_columns([func.sum(Workers_table.c.AnnualRevenue).label("CustomSum"), Workers_table.c.AssociateOID]).group_by(Workers_table.c.AssociateOID))
for instance in rs:

AVG

This example uses the session object's query() method to calculate the average amount of a numeric column in a set of groups:

rs = session.query(func.avg(Workers.AnnualRevenue).label("CustomAvg"), Workers.AssociateOID).group_by(Workers.AssociateOID)
for instance in rs:
	print("Avg: ", instance.CustomAvg)
	print("AssociateOID: ", instance.AssociateOID)
	print("---------")

You can also use the session object's execute() method to invoke AVG:

rs = session.execute(Workers_table.select().with_only_columns([func.avg(Workers_table.c.AnnualRevenue).label("CustomAvg"), Workers_table.c.AssociateOID]).group_by(Workers_table.c.AssociateOID))
for instance in rs:

MAX and MIN

This example finds the maximum value and minimum value of a numeric column in a set of groups.

rs = session.query(func.max(Workers.AnnualRevenue).label("CustomMax"), func.min(Workers.AnnualRevenue).label("CustomMin"), Workers.AssociateOID).group_by(Workers.AssociateOID)
for instance in rs:
	print("Max: ", instance.CustomMax)
	print("Min: ", instance.CustomMin)
	print("AssociateOID: ", instance.AssociateOID)
	print("---------")

You can also use the session object's execute() method to invoke MAX and MIN:

rs = session.execute(Workers_table.select().with_only_columns([func.max(Workers_table.c.AnnualRevenue).label("CustomMax"), func.min(Workers_table.c.AnnualRevenue).label("CustomMin"), Workers_table.c.AssociateOID]).group_by(Workers_table.c.AssociateOID))
for instance in rs:

Modifying Data

Commands can be executed individually by the session with a call to "execute()".

Obtaining the Table Object

The query supplied to this method is constructed using the associated Table object of a mapped class. This Table object is obtained from the mapped class's metadata field, as below:

Workers_table = Workers.metadata.tables["Workers"]

Once the table object is obtained, the write operations are executed in the following ways. The queries are executed immediately without the need for a call to "commit()":

Insert

The following example adds a new record to the table:

session.execute(Workers_table.insert(), {"AssociateOID": "Jon Doe", "WorkerID": "John"})

Update

The following example modifies an existing record in the table:

session.execute(Workers_table.update().where(Workers_table.c.Id == "6").values(AssociateOID="Jon Doe", WorkerID="John"))

Delete

The following example removes an existing record from the table:

session.execute(Workers_table.delete().where(Workers_table.c.Id == "6"))

From Pandas

When combined with the connector, Pandas can be used to generate data frames that contain your ADP data. Once created, a data frame can be passed to various other Python packages.

Connecting

Pandas relies on an SQLAlchemy engine to execute queries. Before you can use Pandas you must import it:

import pandas as pd
from sqlalchemy import create_engine
engine = create_engine("adp:///?InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")

Querying Data

In Pandas, SELECT queries are provided in a call to the read_sql() method, alongside a relevant connection object. Pandas executes the query on that connection, and returns the results in the form of a data frame, which can be used for a variety of purposes.

df = pd.read_sql("""
	SELECT
	   AssociateOID,
	   WorkerID,
     $exNumericCol;
	FROM Workers;""", engine)
print(df)

Modifying Data

To insert new records into a table, create a new data frame, and define its fields accordingly. When that is done, call to_sql() on the data frame to perform the INSERT operation with the connector, as shown in the example below. You must set the "if _exists" argument to "append" to prevent Pandas from attempting building the table from scratch. To prevent Pandas from writing the data frame index as a column, set index=False.

df = pd.DataFrame({"AssociateOID": ["Jon Doe"], "WorkerID": ["John"]})
df.to_sql("Workers", con=engine, if_exists="append", index=False)

From Matplotlib

Matplotlib contains a number of tools that can graphically model ADP data after being fed a data frame From Pandas.

Using PyPlot

Before any Matplotlib tool, such as pyplot, can be used, it must be imported:

from matplotlib import pyplot as plt

Once a Pandas data frame is obtained, it can be used to create a plot visualizing ADP data. For example, the following plot generates and displays a bar graph relating AssociateOID and AnnualRevenue values:

df.plot(kind="bar", x="AssociateOID", y=["AnnualRevenue"])
plt.show()

From Petl

The connector can be used to create ETL applications and pipelines for CSV data in Python using Petl.

Install Required Modules

Install the Petl modules using the pip utility.

pip install petl

Connecting

After you import the modules, including the CData Python Connector for ADP, you can use the connector's connect function to create a connection using a valid ADP connection string. If you prefer not to use a direct connection, you can use a SQLAlchemy engine.

import petl as etl
import cdata.adp as mod
cnxn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")

Extract, Transform, and Load the ADP Data

Create a SQL query string and store the query results in a DataFrame.

sql = "SELECT	AssociateOID, WorkerID FROM Workers "
table1 = etl.fromdb(cnxn,sql)

Loading Data

With the query results stored in a DataFrame, you can load your data into any supported Petl destination. The following example loads the data into a CSV file.

etl.tocsv(table1,'output.csv')

Modifying Data

Insert new rows into ADP tables using Petl's appenddb function.

table1 = [['AssociateOID','WorkerID'],['Jon Doe','John']]
etl.appenddb(table1,cnxn,'Workers')

Schema Discovery

The extension supports schema discovery by using SQL queries to available System Tables.

Using SQL

The following sections describe the discovery of metadata through several System Tables:

Tables and Views
Columns
Procedures

Tables and Views

The connector possesses system tables that are used to discover the tables and views available in the data model. Of these system tables, "sys_tables" and "sys_views" are used to fetch information about the available tables and views respectively:

Tables

import cdata.adp as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tables"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Views

import cdata.adp as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")
cur = conn.cursor()
cmd = "SELECT * FROM sys_views"
cur.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

Columns

The available columns for any given table are fetched from a system table called "sys_tablecolumns". A specific table name is provided in the WHERE criteria to restrict the table from which the column information is fetched:

import cdata.adp as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tablecolumns WHERE TableName = 'Workers'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Procedures

A system table called "sys_procedures" is queried to obtain the available stored procedures that are executed:

import cdata.adp as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedures"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Parameters

The input parameters of any stored procedure are similarly obtained from the "sys_procedureparameters" system table:

import cdata.adp as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Advanced Features

This section details a selection of advanced features of the ADP connector.

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the connector for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Caching Data

Caching Data enables faster access to data and reduces the number of API calls, improving performance. The connector supports a simple caching model where multiple connections can also share the cache over time. When configuring the cache connection, you can specify automatic or explicit data caching.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to ADP and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Exception Handling

For an overview of how exceptions are reported and the components of an exception, see Exception Handling.

User Defined Views

The CData Python Connector for ADP supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from a tool.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

Create a JSON-formatted configuration file defining the views you want.
DDL statements.

Defining Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Workers WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Defining Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Working with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

Inserting Parent and Child Records

Use Case

Sometimes, when inserting records, it's necessary to supply details about child records that have a dependency on a parent.

For example, when dealing with a CRM system, Invoices often cannot be entered without at least one line item. Since invoice line items can have several fields, this presents a unique challenge when offering the data as relational tables. When reading the data, it is easy enough to model an Invoice and an InvoiceLineItem table with a foreign key connecting the two. However, during inserts, the CRM system requires both the Invoice and the InvoiceLineItems to be created in a single submission.

To solve this sort of problem, our tools offer child collection columns on the parent. These columns can be used to submit insert statements that include details of both the parent and the child records.

For example, let's say that the Invoice table contains a single column called InvoiceLineItems. During the insert, we can pass the details of the records that must be inserted to the InvoiceLineItems table into Invoice record's InvoiceLineItems column.

The following subsection describes how this might be done.

Methods for Inserting Parent/Child Records

The connector facilitates two methods for inserting parent/child records: temporary table insertion and XML aggregate insertion.

Temporary (#TEMP) tables

The simplest way to enter data would be to use a #TEMP table, or temporary table, which the connector will store in memory.

Reference the #TEMP table with the following syntax:

TableName#TEMP

#TEMP tables are stored in memory for the duration of a connection.

Therefore, in order to use them, you cannot close the connection between submitting inserts to them, and they cannot be used in environments where a different connection may be used for each query.

Within that single connection, the table remains in memory until the bulk insert is successful, at which point the temporary table will be wiped from memory.

For example:

INSERT INTO InvoiceLineItems#TEMP (ReferenceNumber, Item, Quantity, Amount) VALUES ('INV001', 'Basketball', 10, 9.99)
INSERT INTO InvoiceLineItems#TEMP (ReferenceNumber, Item, Quantity, Amount) VALUES ('INV001', 'Football', 5, 12.99)

Once the InvoiceLineItems table is populated, the #TEMP table may be referenced during an insert into the Invoice table:

INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', 'InvoiceLineItems#TEMP')

Under the hood, the connector will read in values from the #TEMP table.

Notice that the ReferenceNumber was used to identify what Invoice the lines are tied to. This is because the #TEMP table may be populated and used with a bulk insert, where there are separate lines for each invoice. This enables the #TEMP tables to be used with a bulk insert. For example:

INSERT INTO Invoices#TEMP (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', 'InvoiceLineItems#TEMP')
INSERT INTO Invoices#TEMP (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV002', 'Jane Doe', 'InvoiceLineItems#TEMP')
INSERT INTO Invoices SELECT ReferenceNumber, Customer, InvoiceLines FROM Invoices#TEMP

In this case, we are inserting two different Invoices. The ReferenceNumber is how we determine which Lines go with which Invoice.

Note: The tables and columns presented here are an example of how the connector works in general. The specific table and column names may be different in the connector.

Direct XML Insertion

Direct XML can be used as an alternative to #TEMP tables. Since #TEMP tables are not used to construct them, it does not matter if you use the same connection or close the connection after insert.

For example:

[
  {
    "Item", "Basketball",
    "Quantity": 10
    "Amount": 9.99
  },
  {
    "Item", "Football",
    "Quantity": 5
    "Amount": 12.99
  }
]

OR

<Row>
  <Item>Basketball</Item>
  <Quantity>10</Quantity>
  <Amount>9.99</Amount>
</Row>
<Row>
  <Item>Football</Item>
  <Quantity>5</Quantity>
  <Amount>12.99</Amount>
</Row>

Note that the ReferenceNumber is not present in these examples because the XML, by its nature, is passed against the parent record in full per insert. Since the complete XML must be constructed and submitted for each row, there is no need to provide something to tie the child back to the parent.

Now insert the values:

INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', '{...}')

OR

INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', '<Row>...</Row>')

Note: The connector also supports the use of XML/JSON aggregates.

Example for ADP

For a working example of how temp tables can be used to insert data in ADP, please see the following. In ADP, the Input_* tables are special input only tables designed for assisting with #TEMP table insertion. You do not need to actually append "#TEMP" to them to use them.

Note that key references such as Ids may be different in your environment:

// Insert into Input_configurationTags child table
INSERT INTO Input_configurationTags (TagCode, TagDataType, TagValues, ReferenceNumber) VALUES ('Earning Type', 'String', '"T"', '1')
INSERT INTO Input_configurationTags (TagCode, TagDataType, TagValues, ReferenceNumber) VALUES ('Deduction Type', 'String', '"T"', '2')
INSERT INTO Input_configurationTags (TagCode, TagDataType, TagValues, ReferenceNumber) VALUES ('Deduction Type', 'String', '"P"', '2')

// Insert into Input_EarningInputs child table
INSERT INTO Input_EarningInputs (AssociateOID,PayrollGroupCode,EarningCodeValue,RateValue,NumberOfHours,EarningConfigurationTags,ReferenceNumber) VALUES ('G3BGDF8JG32ERTGK','3TQ','R','50.50', '40', 'Input_configurationTags', '1')
INSERT INTO Input_EarningInputs (AssociateOID,PayrollGroupCode,EarningCodeValue,RateValue,NumberOfHours) VALUES ('G3GGY14BNGZ313W8','3U7','R','50.40', '41');
INSERT INTO Input_EarningInputs (AssociateOID,PayrollGroupCode,EarningCodeValue,NumberOfHours) VALUES ('G3BGDF8JG32ERTGK','3TQ','O','4');

// Insert into Input_DeductionInputs child table
INSERT INTO Input_DeductionInputs (AssociateOID,PayrollGroupCode,DeductionCodeValue,DeductionRateValue,DeductionAmountcurrencyCode) VALUES ('G3BGDF8JG32ERTGK','3TQ','A','10.50', 'USD');
INSERT INTO Input_DeductionInputs (AssociateOID,PayrollGroupCode,DeductionCodeValue,DeductionRateValue,DeductionAmountcurrencyCode) VALUES ('G3BGDF8JG32ERTGK','3U7','A','10', 'USD');

// Insert into Input_ReimbursementInputs child table
INSERT INTO Input_ReimbursementInputs (AssociateOID,PayrollGroupCode,ReimbursementCodeValue,ReimbursementAmountValue,ReimbursementAmountCurrencyCode,ReimbursementConfigurationTags,ReferenceNumber) VALUES ('G3BGDF8JG32ERTGK','3TQ','B','25.00', 'USD', 'Input_configurationTags', '2');
INSERT INTO Input_ReimbursementInputs (AssociateOID,PayrollGroupCode,ReimbursementCodeValue,ReimbursementAmountValue,ReimbursementAmountCurrencyCode) VALUES ('G3BGDF8JG32ERTGK','3U7','B','25.00', 'USD');

//Insert into PayrollRuns parent table
INSERT INTO PayrollRuns#TEMP (PayrollGroupCodeValue, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs,  ReimbursementInputs) VALUES ('3TQ', 'TestProcessing', 'G3BGDF8JG32ERTGK', '1', '050198', 'Input_EarningInputs', 'Input_DeductionInputs', 'Input_ReimbursementInputs');
INSERT INTO PayrollRuns#TEMP (PayrollGroupCodeValue, PayrollWeekNumber, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs,  ReimbursementInputs) VALUES ('3U7', '1', 'TestProcessing', 'G3GGY14BNGZ313W8', '1', '020024', 'Input_EarningInputs', 'Input_DeductionInputs', 'Input_ReimbursementInputs');

// Execute the bulk insert
INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollWeekNumber, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs,  ReimbursementInputs) SELECT PayrollGroupCodeValue, PayrollWeekNumber, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs,  ReimbursementInputs FROM PayrollRuns#TEMP

SSL Configuration

Customizing the SSL Configuration

By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to connect to other proxies, set ProxyAutoDetect to False and read further.

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the connector uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Caching Data

Caching data provides several benefits, including faster access to data and reducing the number of API calls, which improve performance. The connector supports a simple caching model where multiple connections can also share the cache over time. You can enable and configure caching features by setting the necessary connection properties.

Configuring the Cache Connection

Configuring the Caching Database

This section describes the properties for caching data to the persistent store of your choice.

CacheLocation

The CacheLocation property species the path to a file-system-based database. When caching is enabled, a file-system-based database is used by default. If CacheLocation is not specified, this database is stored at the path in Location. If neither of these connection properties are specified, the connector uses a platform-dependent default location.

CacheConnection

The CacheConnection property specifies a database driver and the connection string to the caching database.

CacheDriver and CacheProvider

Both the CacheDriver and CacheProvider properties are supported. Each specifies a database driver and the connection string to the caching database. CacheDriver is designed for Linux and MacOS; CacheProvider is Windows-based.

Caching Metadata

This section describes how to enable caching metadata and how to update the metadata cache.

Before being able to query data, the connector requires relevant metadata to be retrieved. By default, metadata is cached in memory and shared across connections. But if you want to persist across processes, or if metadata requests are expensive, the solution is to cache the metadata to disk.

Enable Caching Metadata

To enable caching of metadata, set CacheMetadata = true and see Configuring the Cache Connection for instructions on how to configure your connection string. The connector caches the metadata the first time it is needed and uses the metadata cache for subsequent requests.

Update the Metadata Cache

Because metadata is cached, changes to metadata on the live source, for example, adding or removing a column or attribute, are not automatically reflected in the metadata cache. To get updates to the live metadata, you need to delete or drop the cached data.

Automatically Caching Data

Automatically caching data is useful when you do not want to rebuild the cache for each query. When you query data for the first time, the connector automatically initializes and builds a cache in the background. When AutoCache = true, the connector uses the cache for subsequent query executions, resulting in faster response times.

Configuring Automatic Caching

Caching the Workers Table

The following example caches the Workers table in the file specified by the CacheLocation property of the connection string.

SELECT AssociateOID, WorkerID FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'

Common Use Case

A common use for automatically caching data is to improve driver performance when making repeated requests to a live data source, such as building a report or creating a visualization. With auto caching enabled, repeated requests to the same data may be executed in a short period of time, but within an allowable tolerance (CacheTolerance) of what is considered "live" data.

Explicitly Caching Data

With explicit caching (AutoCache = false), you decide exactly what data is cached and when to query the cache instead of the live data. Explicit caching gives you full control over the cache contents by using CACHE Statements. This section describes some strategies to use the caching features offered by the connector.

Creating the Cache

To load data in the cache, issue the following statement.

CACHE SELECT * FROM tableName WHERE ...

Once the statement is issued, any matching data in tableName is loaded into the corresponding table.

Updating the Cache

This section describes two ways to update the cache.

Updating with the SELECT Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. However, this statement does not delete extra rows that are already in the cache. This statement only merges the new rows or updates the existing rows.

CACHE SELECT * FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'

Updating with the TRUNCATE Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. This statement can also delete rows in the cache table that are not present in the live data source.

  CACHE WITH TRUNCATE SELECT * FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'

Query the Data in Online or Offline Mode

This section describes how to query the data in online or offline mode.

Online: Select Cached Tables

You can use the tableName#CACHE syntax to explicitly execute queries to the cache while still online, as shown in the following example.

SELECT * FROM Workers#CACHE

Offline: Select Cached Tables

With Offline = true, SELECT statements always execute against the local cache database, regardless of whether you explicitly specify the cached table or not. Modification of the cache is disabled in Offline mode to prevent accidentally updating only the cached data. Executing a DELETE/UPDATE/INSERT statement while in Offline mode results in an exception.

The following example selects from the local cache but not the live data source because Offline = true.

SELECT * FROM Workers WHERE AssociateOID='G3349PZGBADQY8H8' ORDER BY WorkerID ASC

Delete Data from the Cache

You can delete data from the cache by building a direct connection to the database. Note that the connector does not support manually deleting data from the cache.

Common Use Case

A common use for caching is to have an application always query the cached data and only update the cache at set intervals, such as once every day or every two hours. There are two ways in which this can be implemented:

AutoCache = false and Offline = false. All queries issued by the application explicitly reference the tableName#CACHE table. When the cache needs to be updated, the application executes a tableName#CACHE ... statement to bring the cached data up to date.
Offline = true. Caching is transparent to the application. All queries are executed against the table as normal, so most application code does not need to be aware that caching is done. To update the cached data, simply create a separate connection with Offline = false and execute a tableName#CACHE ... statement.

Data Type Mapping

The connector maps types from the data source to the corresponding data type available in the chosen cache database. The following table shows the mappings between the data types configured in the schema and the data types in the database. Some schema types have synonyms which are all listed in the Schema column.

Data Type Mapping

Note: String columns can map to different data types depending on their length.


Schema	.NET	JDBC	SQL Server	Derby	MySQL	Oracle	SQLite	Access
int, integer, int32	Int32	int	int	INTEGER	INT	NUMBER	integer	LONG
smallint, short, int16	Int16	short	smallint	SMALLINT	SMALLINT	NUMBER	integer	SHORT
double, float, real	Double	double	float	DOUBLE	DOUBLE	NUMBER	double	DOUBLE
date	DateTime	java.sql.Date	date	DATE	DATE	DATE	date	DATETIME
datetime, timestamp	DateTime	java.sql.Date	datetime	TIMESTAMP	DATETIME	TIMESTAMP	datetime	DATETIME
time, timespan	TimeSpan	java.sql.Time	time	TIME	TIME	TIMESTAMP	datetime	DATETIME
string, varchar	String	java.lang.String	If length > 4000: nvarchar(max), Otherwise: nvarchar(length)	If length > 32672: LONG VARCHAR, Otherwise VARCHAR(length)	If length > 255: LONGTEXT, Otherwise: VARCHAR(length)	If length > 4000: CLOB, Otherwise: VARCHAR2(length)	nvarchar(length)	If length > 255: LONGTEXT, Otherwise: VARCHAR(length)
long, int64, bigint	Int64	long	bigint	BIGINT	BIGINT	NUMBER	bigint	LONG
boolean, bool	Boolean	boolean	tinyint	SMALLINT	BIT	NUMBER	tinyint	BIT
decimal, numeric	Decimal	java.math.BigDecimal	decimal	DECIMAL	DECIMAL	DECIMAL	decimal	CURRENCY
uuid	Guid	java.util.UUID	nvarchar(length)	VARCHAR(length)	VARCHAR(length)	VARCHAR2(length)	nvarchar(length)	VARCHAR(length)
binary, varbinary, longvarbinary	byte[]	byte[]	binary(1000) or varbinary(max) after SQL Server 2000, image otherwise	BLOB	LONGBLOB	BLOB	BLOB	LONGBINARY

Query Processing

CData has a client-side SQL engine built into the connector library. This enables support for the full capabilities that SQL-92 offers, including filters, aggregations, functions, etc.

For sources that do not support SQL-92, the connector offloads as much of SQL statement processing as possible to ADP and then processes the rest of the query in memory (client-side). This results in optimal performance.

For data sources with limited query capabilities, the connector handles transformations of the SQL query to make it simpler for the connector. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The ADP Query Evaluation component examines SQL queries and returns information indicating what parts of the query the connector is not capable of executing natively.

The ADP Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.

There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.

More Information

For a full discussion of how CData handles query processing, see CData Architecture: Query Execution.

Logging

Capturing connector logging can be very helpful when diagnosing error messages or other unexpected behavior.

Basic Logging

To begin capturing connector logging, set these properties:

Logfile: A filepath that designates the name and location of the log file.
Verbosity: A numerical value (1-5) that determines the amount of detail in the log. See the page in the Connection Properties section for an explanation of the five levels.
MaxLogFileSize: When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
MaxLogFileCount: A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. Minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Once these properties are set, the connector populates the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it is created.

Log Verbosity

The verbosity level determines the amount of detail that the connector reports to the Logfile. Supported Verbosity levels range from 1 to 5.

The following list describes each level:


1	Setting Verbosity to 1 logs the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2	Setting Verbosity to 2 logs everything included in Verbosity 1, cache queries, and additional information about the request.
3	Setting Verbosity to 3 also logs HTTP headers, as well as the body of the request and the response.
4	Setting Verbosity to 4 also logs transport-level communication with the data source. This includes SSL negotiation.
5	Setting Verbosity to 5 also logs communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

For normal operations, Verbosity should not be set to greater than 1. At higher verbosities you can log substantial amounts of data, which can delay execution times.

To refine the logged content further by showing/hiding specific categories of information, see LogModules.

Sensitive Data

Verbosity levels of 3 and higher may capture information that you do not want shared outside of your organization. The following lists information of concern for each level:

Verbosity 3: The full body of the request and the response, which includes all the data returned by the connector
Verbosity 4: SSL certificates
Verbosity 5: Any extra transfer data not included at Verbosity 3, such as non human-readable binary transfer data

Note: Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.

Advanced Logging

You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property. This property allows you to filter the logging using a semicolon-separated list of logging modules.

Example property value:

LogModules=INFO;EXEC;SSL;SQL;META;

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:


Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

Exception Handling

Exceptions can be surfaced from either the API or the CData Python Connector for ADP. Each exception will have an error code, an error message, and a SQL state.

Error Codes

The error code classifies the type of error.


0	NONE	Used for unclassified errors and internally handled errors. This code also covers data source-specific errors that do not fit in any specific category.
65537	TCP_UNKNOWN_HOST	Unable to resolve a hostname (DNS failure).
65538	TCP_CONNECTION_REFUSED	Could not connect to the remote port.
65539	TCP_AUTH_FAILED	Login failed when using a binary authentication protocol. Use this for auth errors when the protocol is not HTTP (LDAP, SASL, Kerberos, ...).
65540	TCP_TIMEOUT	Did not receive a response after sending a request to the server.
65541	TCP_PROTOCOL	For wire protocol drivers. Either the server sent a bad packet that we are unable to process, or we cannot construct a packet to send.
131073	TLS_SERVER_UNTRUSTED	Could not verify SSL server certificate.
131074	TLS_CLIENT_UNTRUSTED	Server did not accept the client certificate we sent.
196609	OAUTH_DECRYPT_FAILED	OAuthEncryptKey did not decrypt the OAuthSettings file.
196610	OAUTH_MISSING_CLIENT_INFO	OAuthClientId / OAuthClientSecret / OAuthJWTCert is missing.
196611	OAUTH_MISSING_PROP	General OAuth property missing. OAUTH_MISSING_CLIENT_INFO is used for missing client ID/secret and JWT cert.
196612	OAUTH_NO_ACCESS_TOKEN	Unable to retrieve access token. Only use this when getting a token in GetOAuthAccessToken / RefreshOAuthAccessToken.
196613	OAUTH_TOKEN_EXPIRED	The access token expired. Normally used with a RefreshOAuth/OAuthException behavior.
196614	OAUTH_INVALID_PROP	OAuth property has an invalid value. OAUTH_MISSING_CLIENT_INFO / OAUTH_MISSING_PROP is used if the value is not set.
262145	HTTP_REQUEST_TIMEOUT	Did not receive a response from the HTTP server.
262146	HTTP_CLIENT_ERROR	Generic HTTP 4xx error. Only use for 4xx errors not covered by other codes.
262147	HTTP_AUTH_FAILED	HTTP 401 error.
262148	HTTP_LIMIT_EXCEEDED	HTTP 429 error.
262149	HTTP_SERVER_ERROR	HTTP 5xx error.
262150	HTTP_NOT_FOUND_ERROR	HTTP 404 error.
327681	CORE_TIMEOUT	General timeout. Not related to a specific network request.
327682	CORE_OP_NOT_ALLOWED	Operation blocked by provider permissions.
327683	CORE_CONNECTION_CONFIG	Connection configuration is not valid.
327684	CORE_SERIALIZE	Failed to encode data into a specific format (XML, JSON, CSV, ...).
327685	CORE_DESERIALIZE	Failed to decode data from a specific format (XML, JSON, CSV, ...).
393217	SQL_SYNTAX_ERROR	Unable to parse a SQL query.
393218	SQL_MISSING_COLUMNS	Query did not include required columns.
393219	SQL_MISSING_PARAMS	Stored procedure call did not include required parameters.
393220	SQL_QUERY_NOT_SUPPORTED	A part of the query is not allowed in the current context.
458753	SSH_SERVER_UNTRUSTED	Could not verify SSH server.
524289	STORAGE_LIST_EXCEPTION	Issue listing storage resources.
524290	STORAGE_RESOURCE_NOT_FOUND	Issue finding storage resources.
524291	STORAGE_ROOT_RESOURCE_NOT_FOUND	The root resource (bucket/share/drive) was not found; cannot create it in flat file drivers.
524292	STORAGE_RESOURCE_NOT_A_DIRECTORY	Storage resource is not a directory.
524293	STORAGE_RESOURCE_NOT_A_FILE	Storage resource is not a file.
524294	STORAGE_PERMISSIONS_DENIED	Storage permissions denied.

SQL State

The SQL state is used when throwing generic provider errors to the wrapper and indicates the success or failure of a call.

Some of the common SQL states are listed below:


07007	REQUIRED_CLAUSE	Class Code 07: Dynamic SQL Error.
08001	OPEN_CONNECTION	Class Code 08: Connection Exception. The connection was unable to be established to the application server or other server.
08004	REJECT_CONNECTION	The application server rejected establishment of the connection.
42501	PRIVILEGE_IDENTIFIED_OBJECT	Class Code 42: Syntax Error or Access Rule Violation. The authorization ID does not have the privilege to perform the specified operation on the identified object.
42506	AUTH_FAILED	Owner authorization failure occurred.
42601	SQL_SYNTAX	A character, token, or clause is invalid or missing.

Error Message

The error message provides more detailed reasoning about why the error occurred. It provides an explanation of the issue, and may include steps on how to resolve it.

SQL Compliance

The CData Python Connector for ADP supports several operations on data, including querying, deleting, modifying, and inserting.

SELECT Statements

See SELECT Statements for a syntax reference and examples.

See Data Model for information on the capabilities of the ADP API.

INSERT Statements

See INSERT Statements for a syntax reference and examples.

UPDATE Statements

The primary key Id is required to update a record. See UPDATE Statements for a syntax reference and examples.

DELETE Statements

The primary key Id is required to delete a record. See DELETE Statements for a syntax reference and examples.

CACHE Statements

CACHE statements allow granular control over the connector's caching functionality. For a syntax reference and examples, see CACHE Statements.

For more information on the caching feature, see Caching Data.

EXECUTE Statements

Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.

Names and Quoting

Table and column names are considered identifier names; as such, they are restricted to the following characters: [A-Z, a-z, 0-9, _:@].
To use a table or column name with characters not listed above, the name must be quoted using square brackets ([name]) in any SQL statement.
Parameter names can optionally start with the @ symbol (e.g., @p1 or @CustomerName) and cannot be quoted.
Strings must be quoted using single quotes (e.g., 'John Doe').

SQL Functions

The connector provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.

The connector interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and connector syntax for the DATENAME function:

SQL Server:
```
SELECT DATENAME(yy,GETDATE())
```
connector:
```
SELECT DATENAME('yy',GETDATE())
```

String Functions

These functions perform string manipulations and return a string value. See STRING Functions for more details.

Date Functions

These functions perform date and date time manipulations. See DATE Functions for more details.

Math Functions

These functions provide mathematical operations. See MATH Functions for more details.

STRING Functions

ASCII(character_expression)

Returns the ASCII code value of the left-most character of the character expression.

character_expression: The character expression.

                      SELECT ASCII('0');
                      --  Result: 48

BASE64_ENCODE(input_binary)

Returns the Base64-encoded string form of a binary input.

input_binary: The binary value to encode.

                        SELECT BASE64_ENCODE(BinaryData);
                    -- Result: 'QmFzZTY0RW5jb2RlZA=='

BASE64_DECODE(input_string)

Returns the binary result of decoding a Base64-encoded string.

input_string: The Base64-encoded string.

                        SELECT BASE64_DECODE('QmFzZTY0RW5jb2RlZA==');
                    -- Result: (binary output)

CHAR(integer_expression)

Converts the integer ASCII code to the corresponding character.

integer_expression: The integer from 0 through 255.

                      SELECT CHAR(48);
                      -- Result: '0'

CHARINDEX(expressionToFind ,expressionToSearch [,start_location ])

Returns the starting position of the specified expression in the character string.

expressionToFind: The character expression to find.
expressionToSearch: The character expression, typically a column, to search.
start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT CHARINDEX('456', '0123456');
                      -- Result: 4

                      SELECT CHARINDEX('456', '0123456', 5);
                      -- Result: -1

CHAR_LENGTH(character_expression),

Returns the number of UTF-8 characters present in the expression.

character_expression: The set of characters to be evaluated for length.

				 SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
				 -- Result: 11

CONCAT(string_value1, string_value2, ..., string_valueN)

Returns the string that is the concatenation of two or more string values.

string_value1: The first string to be concatenated.
string_value2: The second string to be concatenated.
string_valueN: (optional) Any additional strings to be concatenated.

                      SELECT CONCAT('Hello, ', 'world!');
                      -- Result: 'Hello, world!'

CONTAINS(expressionToSearch, expressionToFind)

Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.

expressionToSearch: The character expression, typically a column, to search.
expressionToFind: The character expression to find.

                      SELECT CONTAINS('0123456', '456');
                      -- Result: 1

                      SELECT CONTAINS('0123456', 'Not a number');
                      -- Result: 0

ENDSWITH(character_expression, character_suffix)

Returns 1 if character_expression ends with character_suffix; otherwise, 0.

character_expression: The character expression.
character_suffix: The character suffix to search for.

                      SELECT ENDSWITH('0123456', '456');
                      -- Result: 1

                      SELECT ENDSWITH('0123456', '012');
                      -- Result: 0

FILESIZE(uri)

Returns the number of bytes present in the file at the specified file path.

uri: The path of the file from which to read the size.

				SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
				-- Result: 23684

FORMAT(value [, parseFormat], format )

Returns the value formatted with the specified format.

value: The string to format.
format: The string specifying the output syntax of the date or numeric format.
parseFormat: The string specifying the input syntax of the date value. Not applicable to numeric types.

                      SELECT FORMAT(12.34, '#');
                      -- Result: 12

                      SELECT FORMAT(12.34, '#.###');
                      -- Result: 12.34

                      SELECT FORMAT(1234, '0.000E0');
                      -- Result: 1.234E3
                      
                      SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
                      -- Result: 2019-01-01
                      
                      SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
                      -- Result: '2019-01-01'

HASHBYTES(algorithm, value)

Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.

algorithm: The algorithm to use for hashing. Must be one of MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, or SHA3_512.
value: The value to hash. Must be either a string or byte array.

                      SELECT HASHBYTES('MD5', 'Test');
                      -- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B

INDEXOF(expressionToSearch, expressionToFind [,start_location ])

Returns the starting position of the specified expression in the character string.

expressionToSearch: The character expression, typically a column, to search.
expressionToFind: The character expression to find.
start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT INDEXOF('0123456', '456');
                      -- Result: 4

                      SELECT INDEXOF('0123456', '456', 5);
                      -- Result: -1

ISALPHABETIC(character_expression)

Returns 1 if the character expression consists only of alphabetic characters; otherwise, 0.

character_expression: The string expression to evaluate.

                      SELECT ISALPHABETIC('Hello');
                      -- Result: 1

                      SELECT ISALPHABETIC('Hello123');
                      -- Result: 0

                      SELECT ISALPHABETIC('Hello!');
                      -- Result: 0

ISALPHANUMERIC(character_expression)

Returns 1 if the character expression consists only of alphabetic and numeric characters; otherwise, 0.

character_expression: The string expression to evaluate.

                      SELECT ISALPHANUMERIC('Hello123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('Hello.123');
                      -- Result: 0

ISNUMERIC(character_expression)

Returns 1 if the character expression consists only of numeric digits and up to one decimal point; otherwise, 0.

character_expression: The string expression to evaluate.

                      SELECT ISNUMERIC('123');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45.67');
                      -- Result: 0

                      SELECT ISNUMERIC('12a3');
                      -- Result: 0

JSON_EXTRACT(json, jsonpath)

Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to extract.
jsonpath: The XPath used to select the nodes. The JSONPath must be a string constant. The values of the nodes selected will be returned in a token-separated list.

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
                      -- Result: '{"data":1}'

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
                      -- Result: 1

                      SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
                      -- Result: 2

LEFT ( character_expression , integer_expression )

Returns the specified number of characters counting from the left of the specified string.

character_expression: The character expression.
integer_expression: The positive integer that specifies how many characters will be returned counting from the left of character_expression.

                      SELECT LEFT('1234567890', 3);
                      -- Result: '123'

LEN(string_expression)

Returns the number of characters of the specified string expression.

string_expression: The string expression.

                      SELECT LEN('12345');
                      -- Result: 5

LOCATE(substring,string)

Returns an integer representing how many characters into the string the substring appears.

substring: The substring to find inside larger string.
string: The larger string that is searched for the substring.
start locations: An optional integer that sets the character position (offset) from which to start searching.

				SELECT LOCATE('sample','XXXXXsampleXXXXX');
				-- Result: 6

                SELECT LOCATE('sample', 'XXXXXsampleXXXXX', 7)
                -- Result: 0

LOWER ( character_expression )

Returns the character expression with the uppercase character data converted to lowercase.

character_expression: The character expression.

                      SELECT LOWER('MIXED case');
                      -- Result: 'mixed case'

LTRIM(character_expression)

Returns the character expression with leading blanks removed.

character_expression: The character expression.

                      SELECT LTRIM('     trimmed');
                      -- Result: 'trimmed'

MASK(string_expression, mask_character [, start_index [, end_index ]])

Replaces the characters between start_index and end_index with the mask_character within the string.

string_expression: The string expression to be searched.
mask_character: The character to mask with.
start_index: The optional number of characters to leave unmasked at beginning of string. Defaults to 0.
end_index: The optional number of characters to leave unmasked at end of string. Defaults to 0.

                        SELECT MASK('1234567890','*',);
                        -- Result: '**********'
                        SELECT MASK('1234567890','*', 4);
                        -- Result: '1234******'
                        SELECT MASK('1234567890','*', 4, 2);
                        -- Result: '1234****90'

NCHAR(integer_expression)

Returns the Unicode character with the specified integer code as defined by the Unicode standard.

integer_expression: The integer from 0 through 65535 (0 through xFFFF).

OCTET_LENGTH(character_expression),

Returns the number of bytes present in the expression.

character_expression: The set of characters to be be evaluated.

				 SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
				 -- Result: 4

PATINDEX(pattern, expression)

Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.

pattern: The character expression that contains the sequence to be found. The wild-card character % can be used only at the start or end of the expression.
expression: The expression, typically a column, to search for the pattern.

                      SELECT PATINDEX('123%', '1234567890');
                      -- Result: 1

                      SELECT PATINDEX('%890', '1234567890');
                      -- Result: 8

                      SELECT PATINDEX('%456%', '1234567890');
                      -- Result: 4

POSITION(expressionToFind IN expressionToSearch)

Returns the starting position of the specified expression in the character string.

expressionToFind: The character expression to find.
expressionToSearch: The character expression, typically a column, to search.

                      SELECT POSITION('456' IN '123456');
                      -- Result: 4

                      SELECT POSITION('x' IN '123456');
                      -- Result: 0

QUOTENAME(character_string [, quote_character])

Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.

character_string: The string of Unicode character data. The string is limited to 128 characters. Inputs greater than 128 characters return null.
quote_character: An optional single character to be used as the delimiter. These include:
- a single quotation mark (')
- a left or right bracket ([])
- a double quotation mark (")
- a left or right parenthesis ( () )
- a greater or less than sign (><)
- a left or right brace ({})
- a backtick (`)
If quote_character is not specified brackets are used. If an unacceptable character is supplied, it returns NULL.

                      SELECT QUOTENAME('table_name');
                      -- Result: '[table_name]'

                      SELECT QUOTENAME('table_name', '"');
                      -- Result: '"table_name"'

                      SELECT QUOTENAME('table_name', '[');
                      -- Result: '[table_name]'

REGEXP_REPLACE(expr, pattern [, replacement [, position [, occurrence [, match_type]]]])

Replaces occurrences of a regular expression pattern in the input string with a specified value and returns the resulting string.

expr: The string expression to be searched.
pattern: The regular expression pattern to match.
replacement: (optional) The string to replace each matched occurrence of pattern with. Supports backreferences \1 through \9 and escape sequences \n, \r, \t, and \\. By default, this argument is an empty string, meaning matched portions are removed from the output string.
position: (optional) The 1-based starting position used when searching for regular expression matches in expr. The default is 1. All characters prior to the starting position are included in the output string unaltered. Skipped characters are ignored when calculating regular expression matches, even if they match pattern.
occurrence: (optional) Specifies whether all occurrences of pattern,, or only a specific occurrence of pattern are replaced. The default is 0, which means all occurrences of pattern are replaced with replacement. Set to 1 to only replace the first instance of the pattern; 2 to replace the second; etc.
match_type: (optional) Modifiers used to customize matching behavior. Supported values are: 'c' (case-sensitive, default), 'i' (case-insensitive), 'm' (multiline), 'n' (dot matches newline), 'x' (extended mode). These can be freely combined by including the letters back to back. For example, 'im' applies the functionality of both 'i' and 'm'. The regular expression syntax used is that of the Extended mode ('x') ignores whitespace and allows inline comments. If the pattern needs to match a literal space, it must be explicitly escaped.

                      SELECT REGEXP_REPLACE('abc123def456', '\d+', 'NUM');
                      -- Result: 'abcNUMdefNUM'

                      SELECT REGEXP_REPLACE('Hello\nHELLO\nhello', '^hello', 'X', 1, 0, 'im');
                      -- Result: 'X\nX\nX'

REPLACE(string_expression, string_pattern, string_replacement)

Replaces all occurrences of a string with another string.

string_expression: The string expression to be searched. This can be a character or binary data type.
string_pattern: The substring to be found. Cannot be an empty string.
string_replacement: The replacement string.

                      SELECT REPLACE('1234567890', '456', '|');
                      -- Result: '123|7890'

                      SELECT REPLACE('123123123', '123', '.');
                      -- Result: '...'

                      SELECT REPLACE('1234567890', 'a', 'b');
                      -- Result: '1234567890'

REPLICATE ( string_expression ,integer_expression )

Repeats the string value the specified number of times.

string_expression: The string to replicate.
integer_expression: The repeat count.

                      SELECT REPLACE('x', 5);
                      -- Result: 'xxxxx'

REVERSE ( string_expression )

Returns the reverse order of the string expression.

string_expression: The string.

                      SELECT REVERSE('1234567890');
                      -- Result: '0987654321'

RIGHT ( character_expression , integer_expression )

Returns the right part of the string with the specified number of characters.

character_expression: The character expression.
integer_expression: The positive integer that specifies how many characters of the character expression will be returned.

                      SELECT RIGHT('1234567890', 3);
                      -- Result: '890'

RTRIM(character_expression)

Returns the character expression after it removes trailing blanks.

character_expression: The character expression.

                      SELECT RTRIM('trimmed     ');
                      -- Result: 'trimmed'

SOUNDEX(character_expression)

Returns the four-character Soundex code, based on how the string sounds when spoken.

character_expression: The alphanumeric expression of character data.

                      SELECT SOUNDEX('smith');
                      -- Result: 'S530'

SPACE(repeatcount)

Returns the string that consists of repeated spaces.

repeatcount: The number of spaces.

                      SELECT SPACE(5);
                      -- Result: '     '

SPLIT(string, delimiter, offset)

Returns a section of the string between to delimiters.

string: The string to split.
delimiter: The character to split the string with.
offset: The number of the split to return. Positive numbers are treated as offsets from the left, and negative numbers are treated as offsets from the right.

                      SELECT SPLIT('a/b/c/d', '/', 1);
                      -- Result: 'a'
                      SELECT SPLIT('a/b/c/d', '/', -2);
                      -- Result: 'c'

STARTSWITH(character_expression, character_prefix)

Returns 1 if character_expression starts with character_prefix; otherwise, 0.

character_expression: The character expression.
character_prefix: The character prefix to search for.

                      SELECT STARTSWITH('0123456', '012');
                      -- Result: 1

                      SELECT STARTSWITH('0123456', '456');
                      -- Result: 0

STR ( float_expression [ , integer_length [ , integer_decimal ] ] )

Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.

float_expression: The float expression.
length: The optional total length to return. This includes decimal point, sign, digits, and spaces. The default is 10.
decimal: The optional number of places to the right of the decimal point. The decimal must be less than or equal to 16.

                      SELECT STR('123.456');
                      -- Result: '123'

                      SELECT STR('123.456', 2);
                      -- Result: '**'

                      SELECT STR('123.456', 10, 2);
                      -- Result: '123.46'

STUFF(character_expression , integer_start , integer_length , replaceWith_expression)

Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.

character_expression: The string expression.
start: The integer value that specifies the location to start deletion and insertion. If start or length is negative, null is returned. If start is longer than the string to be modified, character_expression, null is returned.
length: The integer that specifies the number of characters to delete. If length is longer than character_expression, deletion occurs up to the last character in replaceWith_expression.
replaceWith_expression: The expression of character data that will replace length characters of character_expression beginning at the start value.

                      SELECT STUFF('1234567890', 3, 2, 'xx');
                      -- Result: '12xx567890'

SUBSTRING(string_value FROM start FOR length)

Returns the part of the string with the specified length; starts at the specified index.

string_value: The character string.
start: The positive integer that specifies the start index of characters to return.
length: Optional. The positive integer that specifies how many characters will be returned.

                      SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
                      -- Result: '34'

                      SELECT SUBSTRING('1234567890' FROM 3);
                      -- Result: '34567890'

You can also drop the FROM and FOR clauses:

                    SELECT SUBSTRING('1234567890', 3, 2)
                    --Result: '34'
                    SELECT SUBSTRING('1234567890', 3)
                    --Result: '34567890'

TEXT_ENCODE(input_string, charset)

Returns binary output by encoding a string using the specified character set.

input_string: The plain text string.
charset: The character set to use, such as 'UTF-8', 'ISO-8859-1'.

                    SELECT TEXT_ENCODE('Café', 'UTF-8');
                    -- Result: (binary output)

TEXT_DECODE(input_binary, charset)

Returns a string decoded from binary data using the specified character set.

input_binary: The binary value to decode.
charset: The character set used for decoding.

                    SELECT TEXT_DECODE(BinaryData, 'UTF-8');
                    -- Result: 'Café'

TOSTRING(string_value1)

Converts the value of this instance to its equivalent string representation.

string_value1: The string to be converted.

                      SELECT TOSTRING(123);
                      -- Result: '123'

                      SELECT TOSTRING(123.456);
                      -- Result: '123.456'

                      SELECT TOSTRING(null);
                      -- Result: ''

TRIM(trimspec trimchar FROM string_value)

Returns the character expression with leading and/or trailing blanks removed.

trimspec: Optional. If included must be one of the keywords BOTH, LEADING or TRAILING.
trimchar: Optional. If included should be a one-character string value.
string_value: The string value to trim.

                      SELECT TRIM('     trimmed     ');
                      -- Result: 'trimmed'

                      SELECT TRIM(LEADING FROM '     trimmed     ');
                      -- Result: 'trimmed     '

                      SELECT TRIM('-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
                      -- Result: '-----trimmed'

UNICODE(ncharacter_expression)

Returns the integer value defined by the Unicode standard of the first character of the input expression.

ncharacter_expression: The Unicode character expression.

UPPER ( character_expression )

Returns the character expression with lowercase character data converted to uppercase.

character_expression: The character expression.

                      SELECT UPPER('MIXED case');
                      -- Result: 'MIXED CASE'

XML_EXTRACT(xml, xpath [, separator])

Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.

xml: The XML document to extract.
xpath: The XPath used to select the nodes. The nodes selected will be returned in a token-separated list.
separator: The optional token used to separate the items in the flattened response. If this is not specified, the separator will be a comma.

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
                      -- Result: 'a,e,i,o,u'

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
                      -- Result: 'a;e;i;o;u'

MATH Functions

ABS ( numeric_expression )

Returns the absolute (positive) value of the specified numeric expression.

numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT ABS(15);
                      -- Result: 15

                      SELECT ABS(-15);
                      -- Result: 15

ACOS ( float_expression )

Returns the arc cosine, the angle in radians whose cosine is the specified float expression.

float_expression: The float expression that specifies the cosine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ACOS(0.5);
                      -- Result: 1.0471975511966

ASIN ( float_expression )

Returns the arc sine, the angle in radians whose sine is the specified float expression.

float_expression: The float expression that specifies the sine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ASIN(0.5);
                      -- Result: 0.523598775598299

ATAN ( float_expression )

Returns the arc tangent, the angle in radians whose tangent is the specified float expression.

float_expression: The float expression that specifies the tangent of the angle to be returned.

                      SELECT ATAN(10);
                      -- Result: 1.47112767430373

ATN2 ( float_expression1 , float_expression2 )

Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.

float_expression1: The float expression that is the y-coordinate.
float_expression2: The float expression that is the x-coordinate.

                      SELECT ATN2(1, 1);
                      -- Result: 0.785398163397448

CEILING ( numeric_expression ) or CEIL( numeric_expression )

Returns the smallest integer greater than or equal to the specified numeric expression.

numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT CEILING(1.3);
                      -- Result: 2

                      SELECT CEILING(1.5);
                      -- Result: 2

                      SELECT CEILING(1.7);
                      -- Result: 2

COS ( float_expression )

Returns the trigonometric cosine of the specified angle in radians in the specified expression.

float_expression: The float expression of the specified angle in radians.

                      SELECT COS(1);
                      -- Result: 0.54030230586814

COT ( float_expression )

Returns the trigonometric cotangent of the angle in radians specified by float_expression.

float_expression: The float expression of the angle in radians.

                      SELECT COT(1);
                      -- Result: 0.642092615934331

DEGREES ( numeric_expression )

Returns the angle in degrees for the angle specified in radians.

numeric_expression: The angle in radians, an expression of an indeterminate numeric data type except for the bit data type.

                      SELECT DEGREES(3.1415926);
                      -- Result: 179.999996929531

EXP ( float_expression )

Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.

float_expression: The float expression.

                      SELECT EXP(2);
                      -- Result: 7.38905609893065

EXPR ( expression )

Evaluates the expression.

expression: The expression. Operators allowed are +, -, *, /, ==, !=, >, <, >=, and <=.

                      SELECT EXPR('1 + 2 * 3');
                      -- Result: 7

                      SELECT EXPR('1 + 2 * 3 == 7');
                      -- Result: true

FLOOR ( numeric_expression )

Returns the largest integer less than or equal to the numeric expression.

numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT FLOOR(1.3);
                      -- Result: 1

                      SELECT FLOOR(1.5);
                      -- Result: 1

                      SELECT FLOOR(1.7);
                      -- Result: 1

GREATEST(int1,int2,....)

Returns the greatest of the supplied integers.

				SELECT GREATEST(3,5,8,10,1)
				-- Result: 10

HEX(value)

Returns a the equivalent hex for the input value.

value: A string or numerical value to be converted into hex.

				SELECT HEX(866849198);
				-- Result: 33AB11AE
				
				SELECT HEX('Sample Text');
				-- Result: 53616D706C652054657874

JSON_AVG(json, jsonpath)

Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4.5

JSON_COUNT(json, jsonpath)

Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 2

JSON_MAX(json, jsonpath)

Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
                      -- Result: 4

JSON_MIN(json, jsonpath)

Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4

JSON_SUM(json, jsonpath)

Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 9

LEAST(int1,int2,....)

Returns the least of the supplied integers.

				SELECT LEAST(3,5,8,10,1)
				-- Result: 1

LOG ( float_expression [, base ] )

Returns the natural logarithm of the specified float expression.

float_expression: The float expression.
base: The optional integer argument that sets the base for the logarithm.

                      SELECT LOG(7.3890560);
                      -- Result: 1.99999998661119

LOG10 ( float_expression )

Returns the base-10 logarithm of the specified float expression.

float_expression: The expression of type float.

                      SELECT LOG10(10000);
                      -- Result: 4

MOD(dividend,divisor)

Returns the integer value associated with the remainder when dividing the dividend by the divisor.

dividend: The number to take the modulus of.
divisor: The number to divide the dividend by when determining the modulus.

				SELECT MOD(10,3);
				-- Result: 1

NEGATE(real_number)

Returns the opposite to the real number input.

real_number: The real number to find the opposite of.

				SELECT NEGATE(10);
				-- Result: -10
				
				SELECT NEGATE(-12.4)
				--Result: 12.4

PI ( )

Returns the constant value of pi.

                  SELECT PI()
                  -- Result: 3.14159265358979

POWER ( float_expression , y )

Returns the value of the specified expression raised to the specified power.

float_expression: The float expression.
y: The power to raise float_expression to.

                      SELECT POWER(2, 10);
                      -- Result: 1024

                      SELECT POWER(2, -2);
                      -- Result: 0.25

RADIANS ( float_expression )

Returns the angle in radians of the angle in degrees.

float_expression: The degrees of the angle as a float expression.

                      SELECT RADIANS(180);
                      -- Result: 3.14159265358979

RAND ( [ integer_seed ] )

Returns a pseudorandom float value from 0 through 1, exclusive.

seed: The optional integer expression that specifies the seed value. If seed is not specified, a seed value at random will be assigned.

                      SELECT RAND();
                      -- This result may be different, since the seed is randomized
                      -- Result: 0.873159630165044

                      SELECT RAND(1);
                      -- This result will always be the same, since the seed is constant
                      -- Result: 0.248668584157093

ROUND ( numeric_expression [ ,integer_length] [ ,function ] )

Returns the numeric value rounded to the specified length or precision.

numeric_expression: The expression of a numeric data type.
length: The optional precision to round the numeric expression to. When this is omitted, the default behavior will be to round to the nearest whole number.
function: The optional type of operation to perform. When the function parameter is omitted or has a value of 0 (default), numeric_expression is rounded. When a value other than 0 is specified, numeric_expression is truncated.

                      SELECT ROUND(1.3, 0);
                      -- Result: 1

                      SELECT ROUND(1.55, 1);
                      -- Result: 1.6

                      SELECT ROUND(1.7, 0, 0);
                      -- Result: 2

                      SELECT ROUND(1.7, 0, 1);
                      -- Result: 1
                      
                      SELECT ROUND (1.24);
                      -- Result: 1.0

SIGN ( numeric_expression )

Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.

numeric_expression: The expression of an indeterminate data type except for the bit data type.

                      SELECT SIGN(0);
                      -- Result: 0

                      SELECT SIGN(10);
                      -- Result: 1

                      SELECT SIGN(-10);
                      -- Result: -1

SIN ( float_expression )

Returns the trigonometric sine of the angle in radians.

float_expression: The float expression specifying the angle in radians.

                     SELECT SIN(1);
                     -- Result: 0.841470984807897

SQRT ( float_expression )

Returns the square root of the specified float value.

float_expression: The expression of type float.

                      SELECT SQRT(100);
                      -- Result: 10

SQUARE ( float_expression )

Returns the square of the specified float value.

float_expression: The expression of type float.

                      SELECT SQUARE(10);
                      -- Result: 100

                      SELECT SQUARE(-10);
                      -- Result: 100

TAN ( float_expression )

Returns the tangent of the input expression.

float_expression: The expression of type float.

                      SELECT TAN(1);
                      -- Result: 1.5574077246549

TRUNC(decimal_number,precision)

Returns the supplied decimal number truncated to have the supplied decimal precision.

decimal_number: The decimal value to truncate.
precision: The number of decimal places to truncate the decimal number to.

				SELECT TRUNC(10.3423,2);
				-- Result: 10.34

_ROW_NUMBER_()

Returns a row index as an additional column.

				SELECT ColumnName, _ROW_NUMBER_() FROM TableName
				-- Result: ColumnData, 0
				ColumnData2, 1
				ColumnData3, 2

DATE Functions

CURRENT_DATE()

Returns the current date value.

                  SELECT CURRENT_DATE();
                  -- Result: 2018-02-01

CURRENT_TIMESTAMP()

Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.

                  SELECT CURRENT_TIMESTAMP();
                  -- Result: 2018-02-01 03:04:05

DATEADD (datepart , integer_number , date [, dateformat])

Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.

datepart: The part of the date to add the specified number to. The valid values and abbreviations are
- year (yy, yyyy)
- quarter (qq, q)
- month (mm, m)
- week (wk, ww)
- weekday (dw)
- dayofyear (dy, y)
- day (dd, d)
- hour (hh)
- minute (mi, n)
- second (ss, s)
- millisecond (ms)
number: The number to be added.
date: The expression of the datetime data type.
dateformat: The optional output date format.

                  SELECT DATEADD('d', 5, '2018-02-01');
                  -- Result: 2018-02-06

                  SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
                  -- Result: 2018-02-01 05:00:00

DATEDIFF ( datepart , startdate , enddate )

Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.

datepart: The part of the date that is the time interval of the difference between the start date and end date. The valid values and abbreviations are:
- Year (year, yyyy, yy)
- Quarter (quarter, qq, q)
- Month (month, mm, m)
- Week (week, wk, ww)
- Weekday (weekday, dw)
- Dayofyear (dayofyear, dy, y)
- Day (day, dd, d)
- Hour (hour, hh)
- Minute (minute, mi, n)
- Second (second, ss, s)
- Millisecond (millisecond, ms)
startdate: The datetime expression of the start date.
enddate: The datetime expression of the end date.

                  SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
                  -- Result: 9

                  SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
                  -- Result: 12

DATE_FORMAT(date,format)

Returns the date or timestamp in the format specified. This function mirrors the MySQL DATE_FORMAT function.

date: A date or timestamp string.
format: The specifier string of the desired output format. The list of supported format specifiers comes from the MySQL DATE_FORMAT function (see link to MySQL documentation above).

					SELECT DATE_FORMAT('9/4/2021 3:11:53 AM','%h')
					-- Result: 03

DATEFROMPARTS(integer_year, integer_month, integer_day)

Returns the datetime value for the specified year, month, and day.

year: The integer expression specifying the year.
month: The integer expression specifying the month.
day: The integer expression specifying the day.

                    SELECT DATEFROMPARTS(2018, 2, 1);
                    -- Result: 2018-02-01

DATENAME(datepart , date)

Returns the character string that represents the specified date part of the specified date.

datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), and nanosecond (ns).
date: The datetime expression.

                     SELECT DATENAME('yy', '2018-02-01');
                     -- Result: '2018'

                     SELECT DATENAME('dw', '2018-02-01');
                     -- Result: 'Thursday'

DATEPART(datepart, date [,integer_datefirst])

Returns a character string that represents the specified date part of the specified date.

datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), nanosecond (ns), ISODOW, ISO_WEEK (isoweek, isowk,isoww), and ISOYEAR.
date: The datetime string.
datefirst: The optional integer representing the first day of the week. The default is 7, Sunday.

                    SELECT DATEPART('yy', '2018-02-01');
                    -- Result: 2018

                    SELECT DATEPART('dw', '2018-02-01');
                    -- Result: 5

DATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_milliseconds)

Returns the datetime value for the specified date parts.

year: The integer expression specifying the year.
month: The integer expression specifying the month.
day: The integer expression specifying the day.
hour: The integer expression specifying the hour.
minute: The integer expression specifying the minute.
seconds: The integer expression specifying the seconds.
milliseconds: The integer expression specifying the milliseconds.

                    SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
                    -- Result: 2018-02-01 01:02:03.456

DATETIME2FROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the datetime value for the specified date parts.

year: The integer expression specifying the year.
month: The integer expression specifying the month.
day: The integer expression specifying the day.
hour: The integer expression specifying the hour.
minute: The integer expression specifying the minute.
seconds: The integer expression specifying the seconds.
fractions: The integer expression specifying the fractions of the second.
precision: The integer expression specifying the precision of the fraction.

				    SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
                    -- Result: 2018-02-01 01:02:03.456

DATE_TRUNC(date, datepart)

Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.

date: The datetime string that specifies the date.
datepart: Refer to the Oracle documentation for valid datepart syntax.

				    SELECT DATE_TRUNC('05-04-2005', 'YY');
                    -- Result: '1/1/2005'
					
                    SELECT DATE_TRUNC('05-04-2005', 'MM');
                    -- Result: '5/1/2005'

DATE_TRUNC2(datepart, date, [weekday])

Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.

datepart: One of 'millennium', 'century', 'decade', 'year', 'quarter', 'month', 'week', 'day', 'hour', 'minute' or 'second'.
date: The datetime string that specifies the date.
weekday: The optional day of the week to use as the first day for 'week'. One of 'sunday', 'monday', etc.

                    SELECT DATE_TRUNC2('year', '2020-02-04');
                    -- Result: '2020-01-01'

                    SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
                    -- Result: '2020-02-02', which is the previous Monday

DAY(date)

Returns the integer that specifies the day component of the specified date.

date: The datetime string that specifies the date.

                    SELECT DAY('2018-02-01');
                    -- Result: 1

DAYNAME(date)

Returns the name of the day of the week of the specified date.

date: The datetime string that specifies the date.

                    SELECT DAYNAME('8/18/2021');
                    -- Result: Wednesday

DAYOFMONTH(date)

Returns the day of the month of the given date part.

date: The datetime string that specifies the date.

				  SELECT DAYOFMONTH('04/15/2000');
				  -- Result: 15

DAYOFWEEK(date)

Returns the day of the week of the given date part.

date: The datetime string that specifies the date.

				  SELECT DAYOFWEEK('04/15/2000');
				  -- Result: 7

DAYOFYEAR(date)

Returns the day of the year of the given date part.

date: The datetime string that specifies the date.

				  SELECT DAYOFYEAR('04/15/2000');
				  -- Result: 106

EOMONTH(date [, integer_month_to_add ]) or LAST_DAY(date)

Returns the last day of the month that contains the specified date with an optional offset.

date: The datetime expression specifying the date for which to return the last day of the month.
integer_month_to_add: The optional integer expression specifying the number of months to add to the date before calculating the end of the month.

                  SELECT EOMONTH('2018-02-01');
                  -- Result: 2018-02-28
                  
                  SELECT LAST_DAY('2018-02-01');
                  -- Result: 2018-02-28

                  SELECT EOMONTH('2018-02-01', 2);
                  -- Result: 2018-04-30

EXTRACT(date_part FROM date_column_name)

Returns the last day of the month that contains the specified date with an optional offset.

date_part: One of the following date components: YEAR, MONTH, DAY, HOUR, MINUTE, SECOND.
date_column_name: The name of a date column in a table.

                  SELECT EXTRACT(YEAR FROM DateColumn)
                  -- Result: 2021

FDWEEK(date)

Returns the first day of the week of the given date part.

date: The datetime string that specifies the date.
weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the week.

				  SELECT FDWEEK('02-08-2018');
				  -- Result: 2/4/2018

          SELECT FDWEEK('02-08-2018', 1)
          --Result: 02/11/2018

FDMONTH(date)

Returns the first day of the month of the given date part.

date: The datetime string that specifies the date.
month to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the month.

				  SELECT FDMONTH('02-08-2018');
				  -- Result: 2/1/2018

          SELECT FDMONTH('02-08-2018', 1) 
          --Result: 03/01/2018

FDQUARTER(date)

Returns the first day of the quarter of the given date part.

date: The datetime string that specifies the date.
quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the quarter.

				  SELECT FDQUARTER('05-08-2018');
				  -- Result: 4/1/2018

          SELECT FDQUARTER('05-08-2018',1)
          --Result: 07/01/2018

FILEMODIFIEDTIME(uri)

Returns the time stamp associated with the Date Modified of the relevant file.

uri: An absolute path pointing to a file on the local file system.

				 SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
				 -- Result: 6/25/2019 10:06:58 AM

FROM_DAYS(datevalue)

Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.

datevalue: A integer value representing the number of days since 1582-10-15.

				SELECT FROM_DAYS(736000);
				-- Result: 2/6/2015

FROM_UNIXTIME(time, issecond)

Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.

time: The time stamp value from epoch time. Milliseconds are accepted.
issecond: Indicates the time stamp value is milliseconds to epoch time.

                      SELECT FROM_UNIXTIME(1540495231, 1);
                      -- Result: 2018-10-25 19:20:31

                      SELECT FROM_UNIXTIME(1540495357385, 0);
                      -- Result: 2018-10-25 19:22:37

GETDATE()

Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.

                  SELECT GETDATE();
                  -- Result: 2018-02-01 03:04:05

GETUTCDATE()

Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.

In addition, GETUTCDATE can take an optional second parameter, a date and time that are converted to UTC.

                  SELECT GETUTCDATE();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05

                  SELECT GETUTCDATE('2020/08/31 13:56:00')
                  --Result: '2020-08-31 17:56:00'

HOUR(date)

Returns the hour component from the provided datetime.

date: The datetime string that specifies the date.

				SELECT HOUR('02-02-2020 11:30:00');
				-- Result: 11

ISDATE(date, [date_format])

Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.

date: The datetime string.
date_format: The optional datetime format.

                      SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
                      -- Result: 1

                      SELECT ISDATE('Not a date');
                      -- Result: 0

LAST_WEEK()

Returns a time stamp equivalent to exactly one week before the current date.

				SELECT LAST_WEEK();	//Assume the date is 3/17/2020	
			 -- Result: 3/10/2020 00:00:00

LAST_MONTH()

Returns a time stamp equivalent to exactly one month before the current date.

	
				SELECT LAST_MONTH(); //Assume the date is 3/17/2020
				-- Result: 2/17/2020 00:00:00

LAST_YEAR()

Returns a time stamp equivalent to exactly one year before the current date.

				SELECT LAST_YEAR();	//Assume the date is 3/17/2020	
				-- Result: 3/10/2019 00:00:00

LDWEEK(date)

Returns the last day of the provided week.

date: The datetime string.
weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the week.

				SELECT LDWEEK('02-02-2020');
				-- Result: 2/8/2020

LDMONTH(date)

Returns the last day of the provided month.

date: The datetime string.
months to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the month.

				SELECT LDMONTH('02-02-2020');
				-- Result: 2/29/2020

        SELECT LDMONTH('02-08-2020', 1)
        --Result: 03/31/2020

LDQUARTER(date)

Returns the last day of the provided quarter.

date: The datetime string.
quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the quarter.

				SELECT LDQUARTER('02-02-2020');
				-- Result: 3/31/2020

        SELECT LDQUARTER('02-02-2020',1)
        --Result: 06/30/2020

MAKEDATE(year, days)

Returns a date value from a year and a number of days.

year: The year
days: The number of days into the year. Value must be greater than 0.

          SELECT MAKEDATE(2020, 1);
          -- Result: 2020-01-01

MINUTE(date)

Returns the minute component from the provided datetime.

date: The datetime string that specifies the date.

				SELECT MINUTE('02-02-2020 11:15:00');
				-- Result: 15

MONTH(date)

Returns the month component from the provided datetime.

date: The datetime string that specifies the date.

				SELECT MONTH('02-02-2020');
				-- Result: 2

QUARTER(date)

Returns the quarter associated with the provided datetime.

date: The datetime string that specifies the date.

				SELECT QUARTER('02-02-2020');
				-- Result: 1

SECOND(date)

Returns the second component from the provided datetime.

date: The datetime string that specifies the date.

				SELECT SECOND('02-02-2020 11:15:23');
				-- Result: 23

SMALLDATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute)

Returns the datetime value for the specified date and time.

year: The integer expression specifying the year.
month: The integer expression specifying the month.
day: The integer expression specifying the day.
hour: The integer expression specifying the hour.
minute: The integer expression specifying the minute.

                      SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
                      -- Result: 2018-02-01 01:02:00

STRTODATE(string,format)

Parses the provided string value and returns the corresponding datetime.

string: The string value to be converted to datetime format.
format: A format string which describes how to interpret the first string input. A few special formats are available as well, including UNIX, UNIXMILIS, TICKS, and FILETICKS.

				SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
				-- Result: 4/3/2020

SYSDATETIME()

Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.

                  SELECT SYSDATETIME();
                  -- Result: 2018-02-01 03:04:05

SYSUTCDATETIME()

Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.

                  SELECT SYSUTCDATETIME();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05

TIMEFROMPARTS(integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the time value for the specified time and with the specified precision.

hour: The integer expression specifying the hour.
minute: The integer expression specifying the minute.
seconds: The integer expression specifying the seconds.
fractions: The integer expression specifying the fractions of the second.
precision : The integer expression specifying the precision of the fraction.

                      SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
                      -- Result: 01:02:03.456

TO_DAYS(date)

Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.

date: The datetime string that specifies the date.

				SELECT TO_DAYS('02-06-2015');
				-- Result: 736000

WEEK(date)

Returns the week (of the year) associated with the provided datetime.

date: The datetime string that specifies the date.

				SELECT WEEK('02-17-2020 11:15:23');
				-- Result: 8

YEAR(date)

Returns the integer that specifies the year of the specified date.

date: The datetime string.

                      SELECT YEAR('2018-02-01');
                      -- Result: 2018

Date Literal Functions

The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.

L_TODAY()

The current day.

  SELECT * FROM MyTable WHERE MyDateField = L_TODAY()

L_YESTERDAY()

The previous day.

  SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()

L_TOMORROW()

The following day.

  SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()

L_LAST_WEEK()

Every day in the preceding week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()

L_THIS_WEEK()

Every day in the current week.

  SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()

L_NEXT_WEEK()

Every day in the following week.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()

Also available:

L_LAST/L_THIS/L_NEXT MONTH
L_LAST/L_THIS/L_NEXT QUARTER
L_LAST/L_THIS/L_NEXT YEAR

L_LAST_N_DAYS(n)

The previous n days, excluding the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)

L_NEXT_N_DAYS(n)

The following n days, including the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)

Also available:

L_LAST/L_NEXT_90_DAYS

L_LAST_N_WEEKS(n)

Every day in every week, starting n weeks before current week, and ending in the previous week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)

L_NEXT_N_WEEKS(n)

Every day in every week, starting the following week, and ending n weeks in the future.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)

Also available:

L_LAST/L_NEXT_N_MONTHS(n)
L_LAST/L_NEXT_N_QUARTERS(n)
L_LAST/L_NEXT_N_YEARS(n)

SELECT Statements

A SELECT statement can consist of the following basic clauses.

SELECT
INTO
FROM
JOIN
WHERE
GROUP BY
HAVING
UNION
ORDER BY
LIMIT

SELECT Syntax

The following syntax diagram outlines the syntax supported by the SQL engine of the connector:

SELECT {
  [ TOP <numeric_literal> | DISTINCT ]
  { 
    * 
    | { 
        <expression> [ [ AS ] <column_reference> ] 
        | { <table_name> | <correlation_name> } .* 
      } [ , ... ] 
  }
  { 
    FROM <table_reference> [ [ AS ] <identifier> ] 
  } [ , ... ]
  [ [  
      INNER | { { LEFT | RIGHT | FULL } [ OUTER ] } 
    ] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ] 
  ] [ ... ] 
  [ WHERE <search_condition> ]
  [ GROUP BY <column_reference> [ , ... ]
  [ HAVING <search_condition> ]
  [ UNION [ ALL ] <select_statement> ]
  [ 
    ORDER BY 
    <column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
  ]
  [ 
    LIMIT <expression>
    [ 
      { OFFSET | , }
      <expression> 
    ]
  ] 
} | SCOPE_IDENTITY() 

<expression> ::=
  | <column_reference>
  | @ <parameter> 
  | ?
  | COUNT( * | { [ DISTINCT ] <expression> } )
  | { AVG | MAX | MIN | SUM | COUNT } ( <expression> ) 
  | NULLIF ( <expression> , <expression> ) 
  | COALESCE ( <expression> , ... ) 
  | CASE <expression>
      WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
    [ ELSE { <expression> | NULL } ]
    END 
  | {RANK() | DENSE_RANK()} OVER ([PARTITION BY <column_reference>] {ORDER BY <column_reference>})
  | <literal>
  | <sql_function> 

<search_condition> ::= 
  {
    <expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN | IS DISTINCT FROM | IS NOT DISTINCT FROM } [ <expression> ]
  } [ { AND | OR } ... ]

Examples

Return all columns:
```
SELECT * FROM Workers
```

Rename a column:

SELECT [WorkerID] AS MY_WorkerID FROM Workers

Cast a column's data as a different data type:

SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM Workers

Search data:

SELECT * FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'

Return the number of items matching the query criteria:
```
SELECT COUNT(*) AS MyCount FROM Workers 
```
Return the number of unique items matching the query criteria:
```
SELECT COUNT(DISTINCT WorkerID) FROM Workers 
```
Return the unique items matching the query criteria:
```
SELECT DISTINCT WorkerID FROM Workers 
```

Sort a result set in ascending order:

SELECT AssociateOID, WorkerID FROM Workers  ORDER BY WorkerID ASC

Restrict a result set to the specified number of rows:
```
SELECT AssociateOID, WorkerID FROM Workers LIMIT 10 
```
Parameterize a query to pass in inputs at execution time. This enables you to create prepared statements and mitigate SQL injection attacks.
```
SELECT * FROM Workers WHERE AssociateOID = @param
```

See Explicitly Caching Data for information on using the SELECT statement in offline mode.

Pseudo Columns

Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from ADP.

    SELECT * FROM Workers WHERE AsOfDate = '2020-01-01'

Aggregate Functions

For SELECT examples using aggregate functions, see Aggregate Functions.

JOIN Queries

See JOIN Queries for SELECT query examples using JOINs.

Date Literal Functions

Date Literal Functions contains SELECT examples with date literal functions.

Window Functions

See Window Functions for SELECT examples containing window functions.

Table-Valued Functions

See Table-Valued Functions for SELECT examples with table-valued functions.

Aggregate Functions

COUNT

Returns the number of rows matching the query criteria.

SELECT COUNT(*) FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'

COUNT(DISTINCT)

Returns the number of distinct, non-null field values matching the query criteria.

SELECT COUNT(DISTINCT AssociateOID) AS DistinctValues FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'

AVG

Returns the average of the column values.

SELECT WorkerID, AVG(AnnualRevenue) FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'  GROUP BY WorkerID

MIN

Returns the minimum column value.

SELECT MIN(AnnualRevenue), WorkerID FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8' GROUP BY WorkerID

MAX

Returns the maximum column value.

SELECT WorkerID, MAX(AnnualRevenue) FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8' GROUP BY WorkerID

SUM

Returns the total sum of the column values.

SELECT SUM(AnnualRevenue) FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'

JOIN Queries

The CData Python Connector for ADP supports standard SQL joins like the following examples.

Inner Join

An inner join selects only rows from both tables that match the join condition:

SELECT w.WorkerID, w.WorkerOriginalHireDate, a.ItemID, a.ActualStartDate FROM Workers w INNER JOIN WorkersWorkAssignments a ON w.AssociateOID = a.AssociateOID

Left Join

A left join selects all rows in the FROM table and only matching rows in the JOIN table:

SELECT w.WorkerID, w.WorkerOriginalHireDate, a.ItemID, a.ActualStartDate FROM Workers w LEFT JOIN WorkersWorkAssignments a ON w.AssociateOID = a.AssociateOID

Window Functions

Window functions allow you to create computed fields from a group of rows (a window) that return a result for each row, as opposed to one computed result for a set of rows, as is the case with aggregate functions. The connector supports the following window function syntax.

Note: Window function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with window functions may not be optimal.

Window Function Clauses

OVER

The OVER clause defines the window over which window functions are performed.

SELECT A, B, <window function> OVER (<window frame>) FROM TableName

The <window function> refers to any supported window function clause, and the <window frame> refers to one or more clauses that specify the logic by which the window is defined.

PARTITION BY

The PARTITION BY clause subdivides a window into sub-windows called partitions. For each unique value in the column specified in the PARTITION BY clause, every record with that value collectively forms an individual partition.

SELECT A, B, <window function> OVER (PARTITION BY A ORDER BY B) From Workers

The <window function> refers to any supported window function clause.

Window Functions

The connector supports math, ranking, and analytic window functions.

Math

These window functions perform mathematical operations on the records within the window.

COUNT()

Calculates the number of records in each partition. The calculated column is of the data type "int".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT() OVER (PARTITION BY Role) FROM Employees

COUNT_BIG()

Calculates the number of records in each partition. The calculated column is of the data type "bigint".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT_BIG() OVER (PARTITION BY Role) FROM Employees

MIN(numeric_column)

Calculates the minimum value of a numerical column per partition.

In each partition, every record will display the minimum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MIN(Earnings) OVER (PARTITION BY Role) FROM Employees

MAX(numeric_column)

Calculates the maximum value of a numerical column per partition.

In each partition, every record will display the maximum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MAX(Earnings) OVER (PARTITION BY Role) FROM Employees

SUM(numeric_column)

Calculates the sum of a numerical column per partition.

In each partition, every record will display the sum of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, SUM(Earnings) OVER (PARTITION BY Role) FROM Employees

AVG(numeric_column)

Calculates the average value of a numerical column per partition.

In each partition, every record will display the average value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, AVG(Earnings) OVER (PARTITION BY Role) FROM Employees

MEDIAN(numeric_column)

Calculates the median value of a numerical column per partition.

In each partition, every record will display the median value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MEDIAN(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEV(numeric_column)

Calculates the standard deviation of a numerical column per partition.

In each partition, every record will display the standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEV(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEVP(numeric_column)

Calculates the population standard deviation of a numerical column per partition.

In each partition, every record will display the population standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEVP(Earnings) OVER (PARTITION BY Role) FROM Employees

VAR(numeric_column)

Calculates the statistical standard variance of a numerical column per partition.

In each partition, every record will display the statistical standard variance of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VAR(Earnings) OVER (PARTITION BY Role) FROM Employees

VARP(numeric_column)

Calculates the variance population of a numerical column per partition.

In each partition, every record will display the variance population of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VARP(Earnings) OVER (PARTITION BY Role) FROM Employees

Ranking

These window functions rank records that fall within the window and its partitions.

RANK()

Assigns a rank number to each record in a window based on the value of the column specified in the required ORDER BY clause.

If two or more records have an equal value in the in ranked column, they all receive the same rank number and the rank count increments internally, skipping ahead one rank number for each record with a duplicate value in the ORDER BY column.

SELECT AssociateOID, WorkerID, RANK() OVER (ORDER BY WorkerID) AS Rank FROM Workers

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT AssociateOID, WorkerID, RANK() OVER (PARTITION BY AssociateOID ORDER BY WorkerID) AS Rank FROM Workers

DENSE_RANK()

Operates like the RANK() function, but it doesn't increment the internal rank counter for each record with a duplicate value in the ranked column.

This means that, while records with identical values in the ORDER BY column still share a rank number, the function never skips a rank number.

SELECT AssociateOID, WorkerID, DENSE_RANK() OVER (PARTITION BY AssociateOID ORDER BY WorkerID) AS Rank FROM Workers

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT AssociateOID, WorkerID, DENSE_RANK() OVER (PARTITION BY AssociateOID ORDER BY WorkerID) AS Rank FROM Workers

ROW_NUMBER()

Calculates a row number for each record. An ORDER BY clause in the OVER clause is required.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (ORDER BY Role) FROM Employees

If you define multiple partitions with PARTITION BY, a new set of row numbers are calculated for each partition.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (PARTITION BY Role ORDER BY Earnings) FROM Employees

NTILE()

Distributes rows of an ordered partition into a specified number of approximately equal groups, or buckets. It assigns each group a bucket number starting from one. For each row in a group, the NTILE() function assigns a bucket number representing the group to which the row belongs.

The syntax of NTILE() is:

NTILE(buckets) OVER (
    [PARTITION BY partition_expression, ... ]
    ORDER BY sort_expression [ASC | DESC], ...
)

The following are paramaters that NTILE() supports:

buckets: The number of buckets into which the rows are divided. The buckets can be an expression or subquery that evaluates to a positive integer. It cannot be a window function.
PARTITION BY: distributes rows of a result set into partitions to which the NTILE() function is applied.
ORDER BY is clause that specifies the logical order of rows in each partition to which the NTILE() is applied.

If the number of rows is not divisible by the buckets, the NTILE() function returns groups of two sizes with the difference by one. The larger groups always precede the smaller group in the order set by ORDER BY in the OVER() clause.

If the total of rows is divisible by the number of buckets, the function divides the rows evenly among buckets. The following statement creates a new table named ntile_demo that stores 10 integers:

CREATE TABLE sales.ntile_demo (
	v INT NOT NULL
);
	
INSERT INTO sales.ntile_demo(v) 
VALUES(1),(2),(3),(4),(5),(6),(7),(8),(9),(10);	
	
SELECT * FROM sales.ntile_demo;

This statement uses the NTILE() function to divide ten rows into three groups:

SELECT 
	v, 
	NTILE (3) OVER (
		ORDER BY v
	) buckets
FROM 
	sales.ntile_demo;

Analytical

These window functions perform analytical operations on the records within the window.

PERCENT_RANK()

Calculates the relative rank SQL Percentile of each row. It returns values greater than zero, but the maximum value is one. It does not count any NULL values. This function is nondeterministic.

The syntax of PERCENT_RANK() is:

PERCENT_RANK() OVER (
      [PARTITION BY partition_expression, ... ]
      ORDER BY sort_expression [ASC | DESC], ...
  )

This syntax uses the following parameters.

PARTITION BY: By default, SQL Server treats the whole data set as a single set. You can specify the PARTITION BY clause to divide data into multiple sets. The Percent_Rank function performs the analytical calculations on each set. This parameter is optional.
ORDER BY: Sorts the data in either ascending or descending order. This parameter is required.

Table-Valued Functions

Table-valued functions are functions that return a table (rowset).

Note: Table-valued function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with these functions may not be optimal.

Table-Valued Function Clauses

CROSS APPLY

The CROSS APPLY operator is used to perform a subquery on each row of a table or resultset produced by a preceding table expression.

<table_expression_1> CROSS APPLY <table_expression_2>

The second table expression can reference results from the first table expression to create derived columns or an altered recordset via a table-valued function.

Each resulting record is an instance of the record it's splitting, with all the same column values, except for the column(s) containing the value split by the function.

WITH

The WITH clause is used alongside certain table-valued functions to match against constructs within the structure being split (keys, element names, attribute names, etc.) and/or to specify metadata for the columns generated from the function.

SELECT A.ColumnName, X.DerivedColumnName FROM TableName A CROSS APPLY <table-valued function> WITH (DerivedColumnName varchar(255)) AS X

Table-Valued Functions

STRING_SPLIT(input_text,delimiter)

Takes each record in the recordset of the preceding table expression, splits the column containing delimiters (input_text) into substrings separated by the delimiter, and returns one record per substring.

input_text: A column whose value you want to parse.
delimiter: The character used to split the value of the column specified in input_text.

Suppose there is a column called "SplitColumn" with the following content:

One-Two-Three

To unpack this value across multiple records:

SELECT A.ID, X.Value FROM [TableWithDelimitedStringField] A CROSS APPLY STRING_SPLIT(A.SplitColumn,'-') WITH (Value VARCHAR(255)) AS X

-- Results:
-----------
|ID|Value|
|1|One|
|1|Two|
|1|Three|

JSONTABLE(json_content,[jsonpath])

For each record in the recordset of the preceding table expression, returns one record for each instance of a key in a JSON array (json_content) that matches the key(s) specified in the WITH clause, at the scope specified by the "jsonpath" input.

json_content: A JSON "table" (array of objects). The contents can nest, but this must be a single JSON array, not any other JSON structure, at the root level.
- The values of every instance of the key(s) provided in the WITH clause are retrievable only for substructures which are immediate children of the root-level JSON array.
jsonpath: An optional JSONPath query defining the scope, within the json_content array, that you want to pull content from. The JSON key(s) identified in the WITH clause must exist at the scope defined in this parameter. This defaults to the JSON root ($).

Consider a sample table with a single record, including an ID column and column with JSON content called "JSONColumn" with the following content:

[
	{
		"name": "Samuel",
		"email": "sam@gmail.com",
		"extrainfo": {
			"city": "Seattle"
		}
	},
	{
		"name": "Katherine",
		"email": "kat@gmail.com",
	},
	{
		"name": "George",
		"email": "george23@gmail.com",
	},
	{
		"name": "Carlos",
		"email": "carlos32@gmail.com",
	}
]

To extract all values for a certain key, specify the scope in the JSONTABLE function and provide the desired key(s) in the WITH clause.

SELECT A.ID, X.name FROM [TableWithJSONField] A CROSS APPLY JSONTABLE(A.JSONColumn) WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1 |Samuel|
|1 |Katherine|
|1 |George|
|1 |Carlos|

XMLTABLE(xml_content,[xpath,child_type])

For each record in the resultset of the preceding table expression, returns one record for each of the elements and/or attributes in an XML structure (xml_content) that match the tag name(s) and/or attribute name(s) specified in the WITH clause, at the scope specified in the "xpath" input.

xml_content: A column containing an XML structure.
xpath: An optional XPath that specifies the scope within the XML structure at which the connector extracts content matching the tag/attribute name(s) specified in the WITH clause.
- When extracting the content of sub-elements, the connector can retrieve all content from tags at the root level, (depth 0) immediate children of the root (depth 1), and children of those children (depth 2).
- When extracting element attribute content, the connector can retrieve all content from tags containing the specified attribute at the root level (depth 0) and from immediate children of root-level elements (depth 1).
child_type: An optional parameter that specifies the part(s) of the parent element (specified in the xpath input) that the column(s) provided in the WITH clause are checked against to identify content.
- You can supply the following values:
  - 0: The column(s) in the WITH clause are checked for matches against the parent element's attribute names and sub-element tag names.
  - 1: The column(s) in the WITH clause are checked for matches against the parent element's attribute names.
  - 2: The column(s) in the WITH clause are checked for matches against the parent element's sub-element tag names.
- When not supplied, this defaults to 0.

Extracting Sub-Element Values

Consider a sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<shoppingList>
    <item>
        <name>Apples</name>
        <quantity>3</quantity>
        <unit>Kg</unit>
    </item>
    <item>
        <name>Bread</name>
        <quantity>2</quantity>
        <unit>Loaf</unit>
		<extrainfo>
			<Type>Whole-Grain</Type>
		</extrainfo>
    </item>
    <item>
        <name>Milk</name>
        <quantity>1</quantity>
        <unit>Carton</unit>
    </item>
    <item>
        <name>Eggs</name>
        <quantity>12</quantity>
        <unit></unit>
    </item>
</shoppingList>

To extract sub-element content, specify the scope in the XMLTABLE function and provide the desired element name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 1.

SELECT A.ID, X.name FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/item') WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1|Apples|
|1|Bread|
|1|Milk|
|1|Eggs|

Extracting Values Using Element Tag Attributes

Suppose you have this sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<restaurant>
  <dish type="appetizer">
    <name lang="en">Caprese Salad</name>
    <chef>Chef Giovanni</chef>
    <price currency="USD">9.99</price>
  </dish>
  <dish type="main-course">
    <name lang="fr">Boeuf Bourguignon</name>
    <chef>Chef Marie</chef>
    <price currency="EUR">19.99</price>
  </dish>
  <dish type="dessert">
    <name lang="es">Tres Leches Cake</name>
    <chef>Chef Alejandro</chef>
    <price currency="MXN">89.99</price>
  </dish>
</restaurant>

To extract attribute content, specify the scope in the XMLTABLE function and provide the desired attribute name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 2.

SELECT A.ID, X.type FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/dish') WITH (type VARCHAR(255)) AS X

-- Results: 
|ID|type|
---------
|1|appetizer|
|1|main-course|
|1|dessert|

CSVTABLE(csv_content,[delimiter])

For each record in the resultset of the preceding table expression, reads from a column that contains a CSV table (csv_content) and for each record in that CSV table, returns one record containing the value of the CSV column(s) specified in the WITH clause.

csv_content: A column containing a CSV table.
delimiter: An optional custom delimiter (instead of a comma) which splits the CSV content contained in the csv_content input.

Consider a sample table with a single record, including an ID column and a column containing CSV table called "CSVContent" with the following content:

Name;Category;Price
Apple;Fruit;0.99
Spaghetti;Pasta;5.49
Chicken Breast;Meat;8.99
Broccoli;Vegetable;2.49

To select every value in the "Name" column and account for the custom delimiter (;):

SELECT A.ID, X.Name FROM [TableWithCSVField] A CROSS APPLY CSVTABLE(A.CSVContent,';') WITH (Name VARCHAR(255)) AS X

-- Results:
|ID|Name|
-----------
|1|Apple|
|1|Spaghetti|
|1|Chicken Breast|
|1|Broccoli|

INSERT Statements

To create new records, use INSERT statements.

INSERT Syntax

The INSERT statement specifies the columns to be inserted and the new column values. You can specify the column values in a comma-separated list in the VALUES clause, as shown in the following example:

INSERT INTO <table_name> 
( <column_reference> [ , ... ] )
VALUES 
( { <expression> | NULL } [ , ... ] ) 
  

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

The following is an example query:

INSERT INTO Workers (WorkerID) VALUES ('John')

UPDATE Statements

To modify existing records, use UPDATE statements.

Update Syntax

The UPDATE statement takes as input a comma-separated list of columns and new column values as name-value pairs in the SET clause, as shown in the following example:

UPDATE <table_name> SET <select_statement> | {<column_reference> = <expression> [ , ... ]} WHERE { Id = <expression>  } [ { AND | OR } ... ] 

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

The following is an example query:

UPDATE Workers SET WorkerID='John' WHERE Id = @myId

DELETE Statements

To delete information from a table, use DELETE statements.

DELETE Syntax

The DELETE statement requires the table name in the FROM clause and the row's primary key in the WHERE clause, as shown in the following example:

<delete_statement> ::= DELETE FROM <table_name> WHERE { Id = <expression> } [ { AND | OR } ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

The following is an example query:

DELETE FROM Workers WHERE Id = @myId

CACHE Statements

When caching is enabled, CACHE statements provide complete control over the data that is cached and the table to which it is cached. The CACHE statement executes the SELECT statement specified and caches its results to a table with the same name in the cache database or to table specified in <cached_table_name>. The connector updates or inserts rows to the cache depending on whether or not they already exist in the cache, so the primary key, which is used to identify existing rows, must be included in the selected columns.

See Caching Data for more information on different caching strategies.

CACHE Statement Syntax

The cache statement may include the following options that alter its behavior:

CACHE [ <cached_table_name> ] [ WITH TRUNCATE | AUTOCOMMIT | SCHEMA ONLY | DROP EXISTING | ALTER SCHEMA ] <select_statement>

WITH TRUNCATE

If this option is set, the connector removes existing rows in the cache table before adding the selected rows. Use this option if you want to refresh the entire cache table but keep its existing schema.

AUTOCOMMIT

If this option is set, the connector commits each row individually. Use this option if you want to ignore the rows that could not be cached due to some reason. By default, the entire result set is cached as a single transaction.

DROP EXISTING

If this option is set, the connector drops the existing cache table before caching the new results. Use this option if you want to refresh the entire cache table, including its schema.

SCHEMA ONLY

If this option is set, the connector creates the cache table based on the SELECT statement without executing the query.

ALTER SCHEMA

If this option is set, the connector alters the schema of the existing table in the cache if it does not match the schema of the SELECT statement. This option results in new columns or dropped columns, if the schema of the SELECT statement does not match the cached table.

Common Queries

Use the following cache statement to cache all rows of a table:

CACHE SELECT * FROM Workers

Use the following cache statement to cache all rows of a table into the cache table CachedWorkers:

CACHE CachedWorkers SELECT * FROM Workers

Use the following cache statement for incremental caching. The DateModified column may not exist in all tables. The cache statement shows how incremental caching would work if there were such a column. Also, notice that, in this case, the WITH TRUNCATE and DROP EXISTING options are specifically omitted, which would have deleted all existing rows.

CACHE CachedWorkers SELECT * FROM Workers WHERE DateModified > '2013-04-04'

Use the following cache statements to create a table with all available columns that will then cache only a few of them. The sequence of statements cache only AssociateOID and WorkerID even though the cache table CachedWorkers has all the columns in Workers.

CACHE CachedWorkers SCHEMA ONLY SELECT * FROM Workers
CACHE CachedWorkers SELECT AssociateOID, WorkerID FROM Workers

EXECUTE Statements

To execute stored procedures, you can use EXECUTE or EXEC statements.

EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.

Stored Procedure Syntax

To execute a stored procedure as an SQL statement, use the following syntax:

 
{ EXECUTE | EXEC } <stored_proc_name> 
{
  [ @ ] <input_name> = <expression>
} [ , ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

Example Statements

Reference stored procedure inputs by name:

EXECUTE my_proc @second = 2, @first = 1, @third = 3;

Execute a parameterized stored procedure statement:

EXECUTE my_proc second = @p1, first = @p2, third = @p3;

PIVOT and UNPIVOT

PIVOT and UNPIVOT can be used to change a table-valued expression into another table.

PIVOT

PIVOT rotates a table-value expression by turning unique values from one column into multiple columns in the output. PIVOT can run aggregations where required on any column value.

PIVOT Synax

 
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"

UNPIVOT

UNPIVOT carries out nearly the opposite to PIVOT by rotating columns of a table-valued expressions into column values.

UNPIVOT Sytax

 
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"

For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)

INSERT INTO SELECT Statements

Use INSERT INTO SELECT queries to select a list of records from one table and insert those same records into another table as a group. Inserting batches of records in this way may result in improved query performance compared to using many individual INSERT INTO queries.

The table whose records are selected for insertion into another table can be either a real table or a user-defined temporary table.

Inserting Records from Real Tables

To insert a group of records from one real, non-temporary, source table into another destination table, you can use an INSERT INTO SELECT query. This type of query is formatted similarly to a standard INSERT INTO query, except the VALUES clause is substituted with a SELECT query targeting the source table. All records matched by the embedded SELECT query are inserted into the destination table.

If the source table and destination tables have different column names, you must map columns from the source table to the corresponding columns in the destination table you want to insert them into. Perform this mapping by specifying the destination table columns in the same order as the source table columns you want to match them with. For example:

INSERT INTO DestinationTable (A,B,C,D) SELECT Q,R,S,T FROM SourceTable

In this example, the first source column (Q) is inserted into the first destination column (A), the second source column (R) is inserted into the second destination column (B), and so on.

If the source table and destination table both have the same column list with the same names, you can use a streamlined query.

INSERT INTO DestinationTableWithSameColumns SELECT * FROM SourceTable

In this example, there is no need to specify a list of columns for either the source or destination table, because their metadata already matches.

Inserting Records from Temporary Tables

You can manually define and populate temporary tables to hold a list of records for later bulk insertion.

Populate the Temporary Table

To create a temporary table, you must give it a name ending in "#TEMP" and execute an INSERT INTO query using that name, as if that table already existed in the database. After executing the first INSERT INTO, the temporary table exists and can receive subsequent INSERTs. For example:

INSERT INTO Workers#TEMP (WorkerID, MyCustomField__c) VALUES ('New Workers', '9000');
INSERT INTO Workers#TEMP (WorkerID, MyCustomField__c) VALUES ('New Workers 2', '9001');
INSERT INTO Workers#TEMP (WorkerID, MyCustomField__c) VALUES ('New Workers 3', '9002');

This creates a temporary table called Workers#TEMP with two columns and three rows of data. Since type cannot be determined on the temporary table itself, all values are considered strings and later converted to the proper type when they are inserted together into the real (non-temporary) table of interest.

Insert Temporary Table Contents into Real Tables

Once your temporary table is populated, execute an INSERT INTO SELECT query targeting the real (non-temporary) table you want to insert the temporary table's records into. This is formatted similarly to a standard INSERT INTO query, except the VALUES clause is substituted with a SELECT query targeting the matching columns in the temporary table. For example:

INSERT INTO Workers (WorkerID, MyCustomField__c) SELECT WorkerID, MyCustomField__c FROM Workers#TEMP

In this example, the full contents of Workers#TEMP are inserted into the Workers.

Results

The LastResultInfo#TEMP temporary table contains details about the most recently executed query that uses the contents of a temporary table in an embedded SELECT clause, as is the case for INSERT INTO SELECT queries that use a temporary table as the source of records. This table is cleared and repopulated each time such a query is executed. LastResultInfo#TEMP includes information such as whether the query in question succeeded, and how many rows were affected by the query.

Temporary Table Lifespan

Temporary tables only last as long as the connection remains open. When the connection to ADP is closed, all temporary tables are cleared, including the LastResultInfo#TEMP table.

Data Model

The connector models entities in the ADP API as an easy-to-use SQL database, using tables, views, and stored procedures. These are defined in schema files, which are simple, easy-to-read text files that define the structure and organization of data.

Tables

The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your ADP account. The following table includes a list of common tables and views:


Table	Description
AdditionalRemunerationNameCode	Provides reference data for additional remuneration name codes. This view defines supplemental pay elements (for example, bonuses, commissions, or incentive payments) that are recognized in ADP payroll processing. This view is used to standardize remuneration types across payroll reports and calculations.
AssociatePaymentsAllocationsEarningsAndBenefits	Presents detailed information about how each associate's earnings and benefits are allocated in payroll outputs. This view enables reconciliation of earnings categories with corresponding benefit components to ensure accurate financial reporting.
AssociatePaymentsSummaryEarningsAndBenefits	Summarizes all earnings and benefits for each associate within a payroll output. This view provides a high-level snapshot for auditing and financial reconciliation of payroll data.
CostCenters	Returns the cost center codes configured for the client in ADP. This view enables payroll expense tracking and departmental allocation of labor costs for internal reporting and financial analysis.
EarningInputCode	Provides reference data for earning input codes. This view lists earning categories that are used to classify income types such as salary, overtime, or commission in payroll processing.
JobApplications	Returns job-application records that are captured through the ADP recruiting module. It provides applicant data that is used for candidate tracking, evaluation, and onboarding workflows.
jobRequisitions	Returns job requisition data for open or closed positions. It supports hiring pipeline management and alignment of workforce planning with organizational goals.
PaidTimeOffBalances	Returns current paid time-off (PTO) balances for associates. It is used to track available leave accruals, support scheduling, and ensure compliance with company PTO policies.
PaidTimeOffRequests	Returns detailed records of paid time-off (PTO) requests that are submitted by associates. It includes information such as request dates, hours, reasons, and approval statuses. This view is used to track leave management and synchronize approved requests with payroll and scheduling systems.
PayrollGroup	Returns payroll-group information that is configured in ADP. A payroll group defines a collection of workers that share the same payroll cycle, frequency, and processing rules. This view supports payroll scheduling, grouping, and administrative reporting.
PayrollRuns	Records details for each payroll run that is processed in ADP. This table includes key identifiers (Ids), pay-period information, and references to associated inputs such as earnings and deductions. This table enables audit tracking, reconciliation, and historical reporting of payroll operations.
TeamTimeCards	Returns time-card data for all workers in a specific team. This view includes time entries, attendance records, and worked hours. This view supports team-level scheduling, payroll validation, and labor reporting.
TeamTimeCardsDailyTotals	Returns aggregated daily totals from team time cards. This view summarizes the total hours that are worked by team and day, enabling supervisors to monitor attendance patterns and manage overtime compliance.
TeamTimeCardsPeriodTotals	IReturns aggregated period totals from team time cards. This view summarizes total hours, regular pay, and overtime over a complete payroll period. This data supports payroll calculation and compliance with labor regulations.
TimeCards	Returns time-card data for individual workers. This view includes daily and period totals, job codes, and pay types. This view supports time tracking, payroll preparation, and compliance with attendance policies.
TimeCardsDailyTotals	eturns daily time-card totals for individual workers. This view summarizes hours worked each day by category (for example, regular, overtime, or leave) to support payroll review and reporting.
TimeCardsPeriodTotals	Returns total hours and earnings that are aggregated over an entire payroll period for each worker. This view provides summarized data that is used for payroll calculation and compliance tracking.
WorkerDemographics	Returns demographic information for each worker in the organization. This view includes attributes such as age range, gender, ethnicity, and marital status. This view supports diversity analytics, workforce planning, and compliance reporting.
Workers	Returns detailed information for all workers in the organization. This table includes core employee Ids, employment status, and work assignment references. This table serves as the foundation for HR, payroll, and reporting integration.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including deleting and retrieving ADP event notification records, retrieving ADP authentication tokens, and refreshing the OAuth access token for authentication with ADP.

Tables

The connector models the data in ADP as a list of tables in a relational database that can be queried using standard SQL statements.

CData Python Connector for ADP Tables


Name	Description
Input_AdditionalRemunerations	The temporary table that is used to create aggregates for the WorkersWorkAssignments.AdditionalRemunerations table. The table supports temporary staging of remuneration data during payroll processing. The data exists only for the duration of the active connection and is cleared automatically when the connection to ADP is closed.
Input_configurationTags	The temporary table that is used to associate configuration tags with deduction, earning, or reimbursement inputs. The table enables dynamic configuration for payroll processing and exists only during the active connection. When the connection to ADP is closed, all tables that begin with Input_ are cleared.
Input_DeductionInputs	The temporary table that is used to create aggregates for the PayrollRuns.DeductionInputs table. The table supports staging of deduction entries for payroll runs and exists only while the connection remains active. When the connection to ADP is closed, all Input_ tables are cleared.
Input_EarningInputs	The temporary table that is used to create aggregates for the PayrollRuns.EarningInputs table. The table supports payroll run preparation by holding earning entries that are processed in temporary session storage. When the connection to ADP is closed, the data is cleared.
Input_ReimbursementInputs	The temporary table that is used to create aggregates for the PayrollRuns.ReimbursementInputs table. The table temporarily stores reimbursement data for payroll execution. All Input_ tables are cleared when the ADP connection closes.
PayrollRuns	The table that records details for each payroll run that is processed in ADP. This table includes key identifiers (Ids), pay-period information, and references to associated inputs such as earnings and deductions. This table enables audit tracking, reconciliation, and historical reporting of payroll operations.
Workers	The table that returns detailed information for all workers in the organization. This table includes core employee Ids, employment status, and work assignment references. This table serves as the foundation for Human Resources (HR), payroll, and reporting integration.
WorkersPersonCommunicationEmails	The table that stores personal email communication data for workers. This table includes primary and alternate personal email addresses that are maintained in Human Resources (HR) systems for contact and verification purposes.
WorkersPersonCommunicationFaxes	The table that stores personal fax contact data for workers. This table preserves personal fax information for employees in cases where legacy communication records must be retained for compliance.
WorkersPersonCommunicationLandlines	The table that stores personal landline contact information for workers. This table includes residential phone numbers that are maintained in Human Resources (HR) profiles for emergency or verification purposes.
WorkersPersonCommunicationMobiles	The table that stores personal mobile phone contact information for workers. This table supports Human Resources (HR) communications, emergency alerts, and verification processes requiring mobile contact access.
WorkersPersonCommunicationPagers	The table that stores personal pager communication data for workers. This table retains historical pager information that can be required for compliance review or archival purposes.
WorkersWorkAssignments	The table that stores comprehensive information about worker assignments. This table includes assignment Ids, job roles, departments, and reporting relationships. This table forms the foundation for payroll, scheduling, and Human Resources (HR) analytics.

Input_AdditionalRemunerations

The temporary table that is used to create aggregates for the WorkersWorkAssignments.AdditionalRemunerations table. The table supports temporary staging of remuneration data during payroll processing. The data exists only for the duration of the active connection and is cleared automatically when the connection to ADP is closed.

Columns


Name	Type	ReadOnly	References	Description
RemunerationTypeCode	String	False		The code that identifies the type of additional remuneration (for example, a bonus, commission, or allowance). This code is used by ADP to classify and process supplemental pay components during payroll runs.
RemunerationTypeCodeName	String	False		The name that corresponds to the remuneration type code. This field provides a readable label that is displayed in configuration pages, reports, and payroll documentation.
RemunerationRate	Decimal	False		The pay rate that is applied to the additional remuneration. This rate determines the monetary value that is calculated for the specified remuneration type.
RemunerationCurrencyCode	String	False		The currency code that defines the monetary unit for the additional remuneration (for example, USD or CAD). This code ensures that payroll calculations and reporting align with the correct currency standard.
effectiveDate	Date	False		The date that indicates when the additional remuneration becomes effective. This date controls when the remuneration rate and configuration take effect in payroll processing.
NameCode	String	False	AdditionalRemunerationNameCode.CodeValue	The code that represents the name of the remuneration entry. This code links the remuneration record to its corresponding configuration or predefined payroll element.
InactiveIndicator	Boolean	False		The indicator that specifies whether the additional remuneration type is inactive. A value of 'true' indicates that the remuneration type is no longer used in payroll processing, while a value of 'false' indicates that it remains active.

Input_configurationTags

The temporary table that is used to associate configuration tags with deduction, earning, or reimbursement inputs. The table enables dynamic configuration for payroll processing and exists only during the active connection. When the connection to ADP is closed, all tables that begin with Input_ are cleared.

Columns


Name	Type	ReadOnly	References	Description
TagCode	String	False		The code that identifies the configuration tag. This code is used to categorize or label payroll and Human Resource elements within ADP for grouping, filtering, and configuration purposes.
TagDataType	String	False		The data type that defines the format or value type for the configuration tag (for example, string, integer, or date). This information ensures that each tag's input conforms to the expected data format.
TagValues	String	False		The list of possible tag values that is defined for the configuration tag. Enter multiple values as a comma-separated list enclosed in double quotes to ensure proper recognition during data import or processing.
ReferenceNumber	Integer	True		The configuration tag reference number that uniquely identifies each tag record. This number links the tag definition to related payroll or HR configuration data.

Input_DeductionInputs

The temporary table that is used to create aggregates for the PayrollRuns.DeductionInputs table. The table supports staging of deduction entries for payroll runs and exists only while the connection remains active. When the connection to ADP is closed, all Input_ tables are cleared.

Columns


Name	Type	ReadOnly	References	Description
AssociateOID	String	True		The associate identifier (Id) that identifies the worker to whom the deduction applies. This Id links the deduction input to the corresponding worker's payroll and employment data in ADP.
PayrollGroupCode	String	True		The code that identifies the payroll group to which the deduction input applies. This code ensures that deductions are processed within the correct payroll run or company entity.
DeductionCodeValue	String	False	DeductionInputCode.CodeValue	The code that identifies the specific deduction type (for example, Health Insurance, 401(k), or Garnishment). This code maps the deduction input to its associated payroll rule or benefits setup.
DeductionRateValue	Decimal	False		The rate that is applied to calculate the deduction amount for the associate. This rate defines the percentage or fixed value that determines the deduction total.
DeductionAmountcurrencyCode	String	False		The currency code that specifies the monetary unit for the deduction amount (for example, USD or CAD). This code ensures that all deduction values are processed in the correct currency.
DeductionBaseUnitCodeValue	String	False		The code (for example, hourly or per-pay-period) that defines the base unit that is used for calculating the deduction rate. This code ensures that deductions are computed consistently across payroll runs.
DeductionConfigurationTags	String	False		The configuration tags that are associated with the deduction input. These tags are used to categorize, filter, or link deductions to specific configuration rules within ADP.
ReferenceNumber	Integer	True		The configuration tag reference number that uniquely identifies each deduction input record. This number links the record to related configuration data or tag definitions.

Input_EarningInputs

The temporary table that is used to create aggregates for the PayrollRuns.EarningInputs table. The table supports payroll run preparation by holding earning entries that are processed in temporary session storage. When the connection to ADP is closed, the data is cleared.

Columns


Name	Type	ReadOnly	References	Description
AssociateOID	String	True		The unique identifier (Id) that represents the associate to whom the earning input applies. This Id links the earning record to the corresponding worker profile in ADP.
PayrollGroupCode	String	True		The code that identifies the payroll group under which the earning input is processed. This code ensures that earnings are calculated and reported within the correct company or payroll entity.
EarningCodeValue	String	False	EarningInputCode.CodeValue	The code that identifies the specific earning type (for example, Regular Pay, Overtime, or Bonus). This code maps the earning input to its corresponding payroll rule or configuration.
RateValue	Decimal	False		The pay rate that is applied to the earning input. This rate determines how much the associate is compensated per unit of time or work performed.
RatecurrencyCode	String	False		The currency code that specifies the monetary unit for the pay rate (for example, USD or CAD). This code ensures consistent currency alignment across payroll calculations.
NumberOfHours	String	False		The number of hours that is associated with the earning input. This value represents the total time worked that is used to calculate the corresponding earning amount.
EarningsAmountValue	Decimal	False		The total earning amount that is calculated for the associate based on the rate and number of hours. This amount reflects the gross pay before deductions or adjustments.
EarningsCurrencyCode	String	False		The currency code that specifies the monetary unit for the total earning amount. This code ensures that all earnings are reported in the correct currency during payroll processing.
EarningConfigurationTags	String	False		The configuration tags that are associated with the earning input. These tags are used to categorize, filter, or link earnings to specific configuration or reporting rules within ADP.
ReferenceNumber	Integer	True		The configuration tag reference number that uniquely identifies each earning input record. This number links the earning input to related configuration data or tag definitions.

Input_ReimbursementInputs

The temporary table that is used to create aggregates for the PayrollRuns.ReimbursementInputs table. The table temporarily stores reimbursement data for payroll execution. All Input_ tables are cleared when the ADP connection closes.

Columns


Name	Type	ReadOnly	References	Description
AssociateOID	String	True		The unique identifier (Id) that represents the associate to whom the reimbursement applies. This Id links the reimbursement record to the corresponding worker profile in ADP.
PayrollGroupCode	String	True		The code that identifies the payroll group under which the reimbursement input is processed. This code ensures that reimbursements are calculated and reported within the correct company or payroll entity.
ReimbursementCodeValue	String	False	ReimbursementInputCode.CodeValue	The code that identifies the specific reimbursement type (for example, Travel, Meals, or Training). This code maps the reimbursement input to its associated payroll rule or expense configuration.
ReimbursementAmountValue	Decimal	False		The total reimbursement amount that is to be paid to the associate. This amount represents a non-taxable or taxable payment depending on company policy and regulatory settings.
ReimbursementAmountCurrencyCode	String	False		The currency code that specifies the monetary unit for the reimbursement amount (for example, USD or CAD). This code ensures that all reimbursements are processed in the correct currency.
ReimbursementConfigurationTags	String	False		The configuration tags that are associated with the reimbursement input. These tags are used to categorize, filter, or link reimbursement entries to specific configuration or reporting rules within ADP.
ReferenceNumber	Integer	True		The configuration-tag reference number that uniquely identifies each reimbursement input record. This number links the reimbursement entry to related configuration data or tag definitions.

PayrollRuns

The table that records details for each payroll run that is processed in ADP. This table includes key identifiers (Ids), pay-period information, and references to associated inputs such as earnings and deductions. This table enables audit tracking, reconciliation, and historical reporting of payroll operations.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

ItemID supports the '=' comparison.
PayrollRegionCodeValue supports the '=' comparison.
PayrollGroupCodeValue supports the '=' comparison.
PayrollScheduleReferenceScheduleEntryID supports the '=' comparison.
PayrollScheduleReferencePayrollWeekNumber supports the '=' comparison.
PayrollScheduleReferencePayrollYear supports the '=' comparison.
PayrollScheduleReferencePayrollRunNumber supports the '=' comparison.
Level supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PayrollRuns WHERE ItemID = 'TXSMIb+yh9UbJ9-im9au7g=='

SELECT * FROM PayrollRuns WHERE PayrollRegionCodeValue = 'BOST'

SELECT * FROM PayrollRuns WHERE PayrollGroupCodeValue = '3TN'

SELECT * FROM PayrollRuns WHERE PayrollScheduleReferenceScheduleEntryID = '20201117141612-l6OF8VuGHJD1ydLFoe5+nGBEm7rZkaRSorra0woRs04='

SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollWeekNumber = '40'

SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollYear = '2020'

SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollRunNumber = '1'

SELECT * FROM PayrollRuns WHERE Level = 'payroll'

Insert

Following is an example of how to inserting pay data inputs into PayrollRuns table. For example:

INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3U7', 'TestProcessing', 'G3BGDF8JG32ERTGK', '1', '020024', '[{"earningCode":{"codeValue":"R"},"modifierCode":{"codeValue":"1"},"rate":{"rateValue":"44.50"},"configurationTags":[{"tagCode":"ShiftCode","tagValues":["1"]}],"numberOfHours":40},{"earningCode":{"codeValue":"O"},"modifierCode":{"codeValue":"2"},"numberOfHours":4}]', '[{"deductionCode":{"codeValue":"A"},"deductionRate":{"rateValue":9.5,"currencyCode":"USD"}}]', '[{"reimbursementCode":{"codeValue":"B"},"reimbursementAmount":{"amountValue":25,"currencyCode":"USD"}}]')

Inserting pay data inputs using Temp Table.

INSERT INTO PayrollRunsEarningInputs#TEMP (EarningCodeValue, RateValue, NumberOfHours) VALUES ('R', '50.50', '40');
INSERT INTO PayrollRunsDeductionInputs#TEMP (DeductionCodeValue, DeductionRateValue, DeductionAmountcurrencyCode) VALUES ('A', '10', 'USD');
INSERT INTO PayrollRunsReimbursementInputs#TEMP (ReimbursementCodeValue, ReimbursementAmountValue, ReimbursementAmountCurrencyCode) VALUES ('B', '25.00', 'USD');

INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, PayrollWeekNumber, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs,  ReimbursementInputs) VALUES ('3U7', 'TestProcessing', '53', 'G3BGDF8JG32ERTGK', '1', '020024', 'PayrollRunsEarningInputs#TEMP', 'PayrollRunsDeductionInputs#TEMP', 'PayrollRunsReimbursementInputs#TEMP');

Columns


Name	Type	ReadOnly	References	Description
ItemID [KEY]	String	True		The unique identifier (Id) that represents the payroll run record. This Id distinguishes each payroll run within ADP's payroll processing system.
PayrollProcessingJobID	String	False		The Id that identifies the payroll processing job that is associated with the current run. This Id is generated when the payrollProcessingJob.initiate event is triggered.
AlternateJobIDs	String	True		The alternate Ids that are associated with the payroll processing job. These Ids can be used to reference parallel or linked payroll runs within the system.
PayrollRegionCodeValue	String	True		The code that identifies the region in which the payroll is processed. This code ensures correct application of regional tax and labor rules.
PayrollGroupCodeValue	String	False	PayrollGroup.Code	The code that identifies the payroll group that is relevant to this payroll run. This code aligns the run with the appropriate pay cycle and processing configuration.
PayrollGroupCodeShortName	String	True		The short descriptive name that corresponds to the payroll group code. This field provides a concise label for use in reports and dashboards.
PayrollGroupCodeLongName	String	True		The long descriptive name that corresponds to the payroll group code. This field provides a full, readable name used in reports and payroll configuration references.
PayrollScheduleReferencePayrollScheduleID	String	True		The Id that identifies the payroll schedule that is associated with the payroll output. This Id links the payroll run to the applicable pay period schedule.
PayrollScheduleReferenceScheduleEntryID	String	True		The Id that identifies the specific entry within the payroll schedule that is associated with this run. This Id supports traceability between schedule entries and payroll runs.
PayrollScheduleReferencePayrollWeekNumber	String	True		The week number that represents the payroll period within the payroll schedule. This value does not necessarily align with the calendar week number.
PayrollScheduleReferencePayrollYear	String	True		The year that is associated with the payroll period. This value helps identify pay runs that occur within the same fiscal or calendar year.
PayrollScheduleReferencePayrollRunNumber	String	True		The run number that represents the sequence of payroll runs within a given week. This value distinguishes reruns or supplemental payrolls.
PayrollProcessingJobStatusCodeValue	String	True		The code that identifies the processing status of the payroll job (for example, Pending, In Progress, or Completed). This code supports workflow tracking and system monitoring.
PayrollProcessingJobStatusCodeShortName	String	True		The short descriptive name that corresponds to the payroll job status code. This field provides a readable label for display in dashboards and audit reports.
PayrollProcessingJobStatusCodelongName	String	True		The long descriptive name that corresponds to the payroll job status code. This name provides detailed context for reporting and troubleshooting.
AssociatePayments	String	True		The data that is returned for associate payments when the processing level is set to Detail. This field provides access to payment-level breakdowns within the payroll run.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
level	String	The level pseudocolumn that determines the granularity of the data that is returned by the query. Acceptable levels include Summary or Detail. The allowed values are payroll, pay, details, payDetails, acc, acc-all, error, dropped pay, wage garnishements.
AssociateOID	String	The pseudocolumn that identifies the associate who is included in the payroll run. This field supports insert-only operations when payroll data is added to the system.
PayrollWeekNumber	String	The pseudocolumn that represents the payroll week number for insert-only operations. This field helps identify the specific pay period during data insertion.
PayrollFileNumber	String	The pseudocolumn that identifies the payroll file number for insert-only operations. This field ensures that inserted data aligns with the correct file reference.
PayNumber	String	The pseudocolumn that identifies the pay number used in insert-only operations. This field supports sequential tracking of pay entries within the payroll file.
EarningInputs	String	The pseudocolumn that is used for payroll insert-only operations to define earning input data. The following modifier codes are supported for pay data input: 1 (Hours 1 – Regular), 2 (Hours 3 – Code and Quantity), 3 (Hours 3 – Code and Quantity), 4 (Hours 4 – Code and Quantity), 7 (Earnings 3 – Code and Amount), 8 (Earnings 4 – Code and Amount), 9 (Earnings 5 – Code and Amount), and 24 (Temporary Hourly Rate).
DeductionInputs	String	The pseudocolumn that is used for payroll insert-only operations to define deduction input data. This field supports the entry of deduction details during payroll processing.
ReimbursementInputs	String	The pseudocolumn that is used for payroll insert-only operations to define reimbursement input data. This field supports the entry of non-salary payment data for associates.

Workers

The table that returns detailed information for all workers in the organization. This table includes core employee Ids, employment status, and work assignment references. This table serves as the foundation for Human Resources (HR), payroll, and reporting integration.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM Workers WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM Workers WHERE AsOfDate = '2020-01-01'

Insert

Following is an example of how to inserting into Workers table. For example:

INSERT INTO Workers (PayrollGroupCode, OnboardingTemplateCode, OnboardingTemplateCodeName, OnboardingStatusCode, OnboardingStatusCodeName,  HireReasonCode, HireReasonCodeName, WorkerOriginalHireDate, PersonLegalNameGivenName, PersonLegalNameFamilyName1, PersonBirthDate, PersonHighestEducationLevelCode) VALUES ('3UD', '15336_7354', 'HR Only (System)', 'complete', 'complete', 'new', 'TESTHIRE 4', '2020-11-10', 'TestGivenName', 'TestFamilyName', '1990-06-01', 'DOC')

Following is an example of how to inserting into Workers table with WorkAssignements. For example:

INSERT INTO WorkersWorkAssignments#TEMP (StandardHoursQuantity, PayCycleCodeValue, BaseRemunerationHourlyRateAmountValue, WageLawCoverageCodeValue, BaseRemunerationDailyRateAmountValue) VALUES ('45', '4', 300, 'N',  100)

INSERT INTO Workers (PayrollGroupCode, OnboardingTemplateCode, OnboardingTemplateCodeName, OnboardingStatusCode, OnboardingStatusCodeName, HireReasonCode, HireReasonCodeName, WorkerOriginalHireDate, PersonBirthDate, PersonLegalNameFamilyName1, PersonLegalNameGivenName, PersonDisabledIndicator, PersonGenderCode, PersonHighestEducationLevelCode, PersonLegalAddressCityName, PersonLegalAddressCountryCode, PersonLegalAddressCountrySubdivisionLevel1Code, PersonLegalAddressCountrySubdivisionLevel1SubdivisionType, PersonLegalAddressLineOne, PersonLegalAddressLineTwo, PersonLegalAddressLineThree, PersonLegalAddressNameCodeShortName, PersonLegalAddressPostalCode, PersonLegalNameFamilyName1Prefix, PersonLegalNameGenerationAffixCode, PersonLegalNameInitials, PersonLegalNameMiddleName, PersonLegalNameNickName, PersonLegalNameQualificationAffixCode, PersonMaritalStatusCode, PersonMilitaryDischargeDate, PersonMilitaryStatusCode, WorkAssignments) VALUES ('3TQ', '15336_7354', 'HR Only (System)', 'complete', 'complete', 'new', 'TESTHIRE 16', '2020-12-30', '1990-06-02', 'TestGivenName', 'TestFamilyName', 'FALSE', 'M', 'GRD', 'Millburn', 'US', 'NJ', 'state', 'LineOne', 'LineTwo', 'LineThree', 'Legal Residence', '07041', 'Prefix1', '2nd', 'I', 'MiddleName', 'NickName', 'CFA', 'M', '2013-04-01', '12', 'WorkersWorkAssignments#TEMP')

Update

Following is an example of how to Update a Workers table:

UPDATE Workers SET PersonLegalNameGenerationAffixCode = '2nd', PersonLegalNameGivenName = 'GivenName', PersonLegalNameFamilyName1 = 'FamilyName1', PersonLegalNameFamilyName1Prefix = 'Prefix1', PersonLegalNameFamilyName2 = 'FamilyName2', PersonLegalNameFamilyName2Prefix = 'Prefix2', PersonLegalNameInitials = 'C', PersonLegalNameMiddleName = 'MiddleName', PersonLegalNameNickName = 'NickName', PersonLegalNamePreferredSalutations = '[{"salutationCode":{"codeValue":"Mr."},"typeCode":{"shortName":"Social"},"sequenceNumber":1}]', PersonLegalNameQualificationAffixCode = 'CFA' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'

UPDATE Workers SET PersonLegalAddressNameCodeShortName = 'Legal Residence', PersonLegalAddressLineOne = 'LineOne', PersonLegalAddressLineTwo = 'LineTwo', PersonLegalAddressCityName = 'Millburn',  PersonLegalAddressCountryCode = 'US', PersonLegalAddressCountrySubdivisionLevel1SubdivisionType = 'state', PersonLegalAddressPostalCode = '07041' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'

UPDATE Workers SET PersonMaritalStatusCode = 'M', PersonMaritalStatusEffectiveDateTime = '2020-12-01T00:00:00Z' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'

UPDATE Workers SET  PersonHighestEducationLevelCode = 'GRD' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'

UPDATE Workers SET  PersonGenderCode = 'M' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'

UPDATE Workers SET PersonBirthDate = '1990-06-01' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'

UPDATE Workers SET PersonMilitaryClassificationCodes = '[{"codeValue":"R"}]' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'

Columns


Name	Type	ReadOnly	References	Description
AssociateOID [KEY]	String	True		The unique identifier (Id) that represents the associate in the HR system. This field is used to link worker records to other HR data entities and transactions.
WorkerID	String	True		The Id that represents the worker within the HR system. This field is used to uniquely identify an individual across payroll, benefits, and compliance processes.
WorkAssignments	String	False		The collection of work assignment records that are associated with the worker. This field includes position history, job details, and related employment data.
WorkerAcquisitionDate	Date	True		The date when the worker was first acquired or onboarded by the organization. This field is used for workforce analytics and service tracking.
WorkerAdjustedServiceDate	Date	True		The date that reflects the worker's adjusted service calculation, including breaks in service or rehire adjustments. This field supports benefits eligibility and seniority tracking.
WorkerExpectedTerminationDate	Date	True		The anticipated date of the worker's termination, if applicable. This field supports workforce planning and HR forecasting.
WorkerOriginalHireDate	Date	False		The original date when the worker was first hired by the organization. This field is used for service recognition, benefits, and compliance reporting.
WorkerRehireDate	Date	True		The date when the worker was rehired after a separation from employment. This field is used to track re-employment history and eligibility for benefits.
WorkerRetirementDate	Date	True		The date when the worker officially retired from active employment. This field supports retirement processing and benefits administration.
WorkerTerminationDate	Date	True		The date when the worker's employment was officially terminated. This field supports offboarding, compliance reporting, and payroll closure.
WorkerStatusEffectiveDate	Date	True		The date when the worker's current employment status became effective. This field is used for timeline tracking and HR record accuracy.
WorkerStatusReasonCode	String	True		The code that identifies the reason for the worker's current employment status (for example, Leave of Absence, Active, or Terminated). This field supports compliance and workforce analytics.
WorkerStatusReasonLongName	String	True		The full descriptive name of the worker status reason code. This field provides the complete label that appears in HR documentation and reporting.
WorkerStatusReasonShortName	String	True		The abbreviated name that corresponds to the worker status reason code. This field provides a concise label for dashboards and HR reports.
WorkerStatusStatusCode	String	True		The code that identifies the worker's current status (for example, Active, On Leave, or Terminated). This field supports workforce management and payroll processing.
WorkerStatusStatusLongName	String	True		The full descriptive name of the worker status code. This field provides the complete label used in HR documentation and compliance reporting.
WorkerStatusStatusShortName	String	True		The abbreviated name that corresponds to the worker status code. This field provides a short label for HR dashboards and analytics.
Photos	String	True		The collection of photo records that are associated with the worker. This field stores or references identification photos for HR and security purposes.
BusinessCommunicationEmails	String	False		The business email addresses that are assigned to the worker. This field supports internal communication, authentication, and directory listings.
BusinessCommunicationFaxes	String	False		The business fax numbers that are associated with the worker. This field supports official communication and document transmission tracking.
BusinessCommunicationLandlines	String	False		The business landline-telephone numbers that are assigned to the worker. This field supports office contact and telecommunication management.
BusinessCommunicationMobiles	String	False		The business mobile-telephone numbers that are associated with the worker. This field supports contact availability, messaging, and on-call management.
BusinessCommunicationPagers	String	False		The business pager numbers that are associated with the worker. This field supports legacy communication channels where paging devices are still in use.
PersonAlternatePreferredNames	String	True		The alternate preferred names that are associated with the worker's record. This field supports cultural, linguistic, or personal name preferences used across HR systems.
PersonCommunicationEmails	String	False		The personal email addresses that are associated with the worker. This field supports non-business correspondence and optional contact verification.
PersonCommunicationFaxes	String	False		The personal fax numbers that are associated with the worker. This field supports communication through non-business fax channels where applicable.
PersonCommunicationLandlines	String	False		The personal landline-telephone numbers that are associated with the worker. This field supports alternate contact options and address verification.
PersonCommunicationMobiles	String	False		The personal mobile numbers that are associated with the worker. This field supports direct communication for HR outreach and notifications.
PersonCommunicationPagers	String	False		The personal pager numbers that are associated with the worker. This field supports alternate or legacy communication methods maintained in the worker record.
PersonDeathDate	Date	True		The date of the worker's death, if applicable. This field is used for record finalization, benefits closure, and compliance reporting in the HR system.
PersonDeceasedIndicator	Boolean	True		The indicator that specifies whether the worker is deceased. This field is used to manage survivor benefits, payroll termination, and record archival.
PersonDisabilityIdentificationDeclinedIndicator	Boolean	True		The indicator that specifies whether the worker has declined to identify their disability status. This field supports compliance with Equal Employment Opportunity (EEO) and HR data privacy standards.
PersonDisabilityPercentage	Integer	True		The percentage value that represents the worker's level of disability as defined by medical or legal documentation. This field supports compliance tracking and reasonable accommodation processes.
PersonDisabilityTypeCodes	String	False		The codes that identify the worker's disability type classifications (for example, visual impairment, hearing impairment, or mobility limitation). This field supports compliance reporting and accommodation tracking.
PersonDisabledIndicator	Boolean	False		The indicator that specifies whether the worker has self-identified as a person with a disability. This field supports workforce diversity analytics and HR compliance programs.
PersonGenderCode	String	False		The code that identifies the worker's gender (for example, Female, Male, or Nonbinary). This field supports demographic reporting and diversity compliance. The allowed values are M, F, N.
PersonGenderLongName	String	True		The full descriptive name that corresponds to the worker's gender code. This field provides the complete label that appears in HR documentation and workforce analytics.
PersonGenderShortName	String	True		The abbreviated name that corresponds to the worker's gender code. This field provides a concise label for reports and dashboards.
PersonGovernmentIDs	String	False		The collection of government-issued identifiers (for example, Social Security Number, National ID, or Taxpayer ID). This field supports legal and payroll compliance processes.
PersonHighestEducationLevelCode	String	False	HighestEducationLevelCode.CodeValue	The code that identifies the highest level of education completed by the worker (for example, High School, Bachelor's, or Master's). This field supports HR analytics and qualification verification.
PersonHighestEducationLevelLongName	String	True		The full descriptive name of the highest education level code. This field provides the complete label that appears in HR records and reporting systems.
PersonHighestEducationLevelShortName	String	True		The abbreviated name that corresponds to the highest education-level code. This field provides a short label for dashboards and analytics.
PersonIdentityDocuments	String	True		The identity documents that are associated with the worker (for example, driver's license, national ID card, or passport). This field supports verification and regulatory compliance.
PersonImmigrationDocuments	String	True		The immigration-related documents that are associated with the worker (for example, visa, residency card, or work permit). This field supports employment eligibility and legal compliance.
PersonLegalAddressCityName	String	False		The name of the city where the worker's legal address is located. This field supports address validation and HR correspondence.
PersonLegalAddressCountryCode	String	False		The two-letter ISO code that represents the country for the worker's legal address. This field supports localization and international reporting.
PersonLegalAddressCountrySubdivisionLevel1Code	String	False		The code that identifies the first-level administrative subdivision of the country (for example, state, province, or region). This field supports tax and compliance reporting.
PersonLegalAddressCountrySubdivisionLevel1LongName	String	False		The full descriptive name of the first-level administrative subdivision code. This field provides the complete label that appears in HR and payroll documentation.
PersonLegalAddressCountrySubdivisionLevel1ShortName	String	False		The abbreviated name that corresponds to the first-level subdivision code. This field provides a concise label for reports and analytics.
PersonLegalAddressCountrySubdivisionLevel1SubdivisionType	String	False		The type of the first-level administrative subdivision (for example, State, Province, or Region). This field defines the jurisdictional structure used in HR records.
PersonLegalAddressCountrySubdivisionLevel2Code	String	False		The code that identifies the second-level administrative subdivision of the country (for example, county, district, or municipality). This field supports payroll and tax region mapping.
PersonLegalAddressCountrySubdivisionLevel2LongName	String	False		The full descriptive name of the second-level administrative subdivision code. This field provides the complete label that appears in HR records and correspondence.
PersonLegalAddressCountrySubdivisionLevel2ShortName	String	False		The abbreviated name that corresponds to the second-level subdivision code. This field provides a short label for reports and summaries.
PersonLegalAddressCountrySubdivisionLevel2SubdivisionType	String	False		The type of the second-level administrative subdivision (for example, County, District, or Municipality). This field defines the local administrative structure for HR data alignment.
PersonLegalAddressDeliveryPoint	String	False		The delivery point that identifies the physical location for mail delivery. This field supports postal validation and HR correspondence accuracy.
PersonLegalAddressLineOne	String	False		The first address line of the worker's legal address. This field typically includes the building number and street name for postal and HR correspondence.
PersonLegalAddressLineTwo	String	False		The second address line of the worker's legal address. This field is used for additional location details such as apartment number, suite, or unit.
PersonLegalAddressLineThree	String	False		The third address line of the worker's legal address. This field is used for extended address information such as complex, floor, or secondary routing details.
PersonLegalAddressNameCodeValue	String	False		The code that identifies the name element associated with the worker's legal address (for example, home, mailing, or registered). This field defines address categorization within HR systems.
PersonLegalAddressNameCodeLongName	String	True		The full descriptive name of the code that identifies the worker's legal address type (for example, Home, Mailing, or Registered). This field provides the complete label that appears in HR documentation and correspondence.
PersonLegalAddressNameCodeShortName	String	False		The abbreviated name that corresponds to the legal address name code. This field provides a concise label for HR dashboards and address management reports.
PersonLegalAddressPostalCode	String	False		The postal code that identifies the worker's legal address for mail delivery. This field supports postal validation, compliance reporting, and HR correspondence.
PersonLegalAddressSameAsAddressIndicator	Boolean	False		The indicator that specifies whether the worker's legal address is the same as their primary residential address. This field helps prevent duplication in HR systems.
PersonLegalAddressSameAsAddressLinkCanonicalUri	String	False		The canonical uniform resource identifier (URI) that defines the reference link to the related address record. This field is used for record linkage and system integration within HR data models.
PersonLegalAddressSameAsAddressLinkEncType	String	False		The encoding type that is used for the linked address reference. This field supports secure data transmission between HR systems.
PersonLegalAddressSameAsAddressLinkHref	String	False		The hyperlink reference (href) that identifies the related address record. This field supports navigation between address entities in HR systems.
PersonLegalAddressSameAsAddressLinkMediaType	String	False		The media type that defines the format of the linked address resource (for example, application/json or application/xml). This field ensures compatibility across HR system integrations.
PersonLegalAddressSameAsAddressLinkMethod	String	False		The HTTP method that is used to access the linked address resource (for example, GET, POST, or PUT). This field defines how the HR system interacts with the linked data.
PersonLegalAddressSameAsAddressLinkPayLoadArguments	String	False		The payload arguments that are used in the linked address request. This field supports data validation and transfer within HR integrations.
PersonLegalAddressSameAsAddressLinkRel	String	False		The relationship type (rel) that defines the connection between the legal address record and its related address. This field helps describe contextual data relationships.
PersonLegalAddressSameAsAddressLinkSchema	String	False		The schema that defines the data structure for the linked address record. This field ensures consistency in HR data exchange formats.
PersonLegalAddressSameAsAddressLinkTargetSchema	String	False		The schema that defines the data model for the target address record. This field is used to align data across HR integrations and APIs.
PersonLegalAddressSameAsAddressLinkTitle	String	False		The title that describes the purpose or name of the linked address record. This field provides user-friendly context within HR systems and documentation.
PersonLegalNameFamilyName1	String	False		The first family (last) name that is associated with the worker's legal name. This field represents the primary surname in HR and legal documentation.
PersonLegalNameFamilyName1Prefix	String	False		The prefix that appears before the first family name (for example, De, Van, or O'). This field supports accurate name formatting in multilingual and multicultural contexts.
PersonLegalNameFamilyName2	String	False		The second family (last) name that is associated with the worker's legal name, if applicable. This field supports jurisdictions where dual surnames are used.
PersonLegalNameFamilyName2Prefix	String	False		The prefix that appears before the second family name (for example, La, D', or Von). This field supports full representation of the worker's legal name in HR systems.
PersonLegalNameFormattedName	String	False		The fully formatted version of the worker's legal name. This field combines all name components in the correct cultural or jurisdictional order for HR correspondence and identification.
PersonLegalNameGenerationAffixCode	String	False	GenerationAffixCode.CodeValue	The code that identifies the generation affix associated with the worker's legal name (for example, Jr., Sr., or III). This field supports consistent name usage across HR and payroll systems.
PersonLegalNameGenerationAffixLongName	String	True		The full descriptive name of the generation affix code for the worker's legal name. This field provides the complete label that appears in HR and legal records.
PersonLegalNameGenerationAffixShortName	String	True		The abbreviated name that corresponds to the generation affix code for the worker's legal name. This field provides a concise label for reports and employee directories.
PersonLegalNameGivenName	String	False		The given (first) name that is part of the worker's legal name. This field is used for formal identification and HR documentation.
PersonLegalNameInitials	String	False		The initials that represent the worker's legal name. This field supports document signatures, employee badges, and internal identifiers.
PersonLegalNameMiddleName	String	False		The middle name that is part of the worker's legal name. This field supports complete identification and distinguishes between workers with similar names.
PersonLegalNameCode	String	False		The code that identifies the worker's legal name record. This field is used to maintain and track multiple legal name variations within HR systems.
PersonLegalNameLongName	String	True		The full descriptive name of the legal name record. This field provides the complete label that appears in HR documentation and reporting.
PersonLegalNameShortName	String	False		The abbreviated name that corresponds to the legal name record. This field provides a short label for dashboards and HR analytics.
PersonLegalNameNickName	String	False		The nickname or informal name that is associated with the worker's legal name. This field supports communication preferences and HR personalization.
PersonLegalNamePreferredSalutations	String	False		The preferred salutations that are associated with the worker's legal name (for example, Mr., Ms., or Dr.). This field defines how the worker is formally addressed in HR correspondence.
PersonLegalNameQualificationAffixCode	String	False	QualificationAffixCode.CodeValue	The code that identifies the qualification affix associated with the worker's legal name (for example, CPA, MD, or PhD). This field supports credential display and professional recognition.
PersonLegalNameQualificationAffixLongName	String	False		The full descriptive name of the qualification affix code for the worker's legal name. This field provides the complete label that appears in HR and credential verification reports.
PersonLegalNameQualificationAffixShortName	String	False		The abbreviated name that corresponds to the qualification affix code for the worker's legal name. This field provides a concise label for dashboards and HR reporting tools.
PersonLinks	String	True		The set of hyperlinks that connect the worker's personal record to other HR data entities. This field supports record linkage, navigation, and cross-module reporting.
PersonMaritalStatusCode	String	False	MaritalStatusCode.CodeValue	The code that identifies the worker's marital status (for example, Single, Married, or Divorced). This field supports benefits eligibility and demographic reporting.
PersonMaritalStatusEffectiveDateTime	Datetime	False		The date and time when the worker's current marital status became effective. This field supports accurate benefits administration and compliance reporting in HR systems.
PersonMaritalStatusLongName	String	True		The full descriptive name of the code for the worker's marital status. This field provides the complete label that appears in HR documentation and benefits eligibility reports.
PersonMaritalStatusShortName	String	False	MaritalStatusCode.ShortName	The abbreviated name that corresponds to the code for the worker's marital status. This field provides a concise label for HR dashboards and workforce analytics.
PersonMilitaryClassificationCodes	String	False		The codes that identify the worker's military classifications. Supported values include Disabled Veteran, Active Duty Wartime or Campaign Badge Veteran, Armed Forces Service Medal Veteran, and Recently Separated Veteran. This field supports compliance reporting and government reporting obligations.
PersonMilitaryDischargeDate	Date	False		The date when the worker was formally discharged from military service. This field supports verification of veteran status, benefits processing, and compliance with employment regulations.
PersonMilitaryStatusCode	String	False		The code that identifies the worker's military status (for example, Active Duty, Reserve, or Veteran). This field supports HR reporting and regulatory tracking.
PersonMilitaryStatusEffectiveDate	Datetime	True		The date and time when the worker's military status became effective. This field supports accurate recordkeeping for compliance and veteran classification.
PersonMilitaryStatusLongName	String	True		The full descriptive name of the code for the worker's military status. This field provides the complete label that appears in HR documentation and veteran-related reports.
PersonMilitaryStatusShortName	String	False		The abbreviated name that corresponds to the code for the worker's military status. This field provides a concise label for HR dashboards and workforce analytics.
PersonOtherPersonalAddresses	String	False		The additional personal addresses that are associated with the worker. This field supports correspondence, alternate contact management, and legal documentation.
PersonPassports	String	False		The passport details that are associated with the worker. This field supports identity verification, immigration compliance, and international employment tracking.
PersonPreferredNameFamilyName1	String	True		The first family (last) name that is part of the worker's preferred name. This field supports personalization and communication preferences in HR records.
PersonPreferredNameFamilyName1Prefix	String	True		The prefix that appears before the first family name (for example, De, Van, or O'). This field supports accurate cultural and linguistic representation in HR systems.
PersonPreferredNameFamilyName2	String	True		The second family (last) name that is part of the worker's preferred name, if applicable. This field supports naming conventions where dual surnames are used.
PersonPreferredNameFamilyName2Prefix	String	True		The prefix that appears before the second family name (for example, La, D', or Von). This field ensures accurate display of multi-part family names in HR records.
PersonPreferredNameFormattedName	String	True		The fully formatted version of the worker's preferred name. This field displays how the name should appear in communication systems, identification badges, and HR directories.
PersonPreferredNameGenerationAffixCode	String	True		The code that identifies the generation affix associated with the worker's preferred name (for example, Jr., Sr., or III). This field supports standardized name formatting in HR and payroll systems.
PersonPreferredNameGenerationAffixLongName	String	True		The full descriptive name of the generation affix code for the worker's preferred name. This field provides the complete label that appears in HR documentation and communication systems.
PersonPreferredNameGenerationAffixShortName	String	True		The abbreviated name that corresponds to the generation affix code for the worker's preferred name. This field provides a concise label for reports and employee directories.
PersonPreferredNameGivenName	String	True		The given (first) name that is part of the worker's preferred name. This field supports personalization and communication preferences in HR systems.
PersonPreferredNameInitials	String	True		The initials that represent the worker's preferred name. This field supports use in employee badges, reports, and communication identifiers.
PersonPreferredNameMiddleName	String	True		The middle name that is part of the worker's preferred name. This field supports complete identification and personalization in HR records.
PersonPreferredNameCode	String	True		The code that identifies the preferred name record associated with the worker. This field supports management of preferred name variations and change tracking.
PersonPreferredNameLongName	String	True		The full descriptive name of the preferred name record. This field provides the complete label that appears in HR documentation and employee directories.
PersonPreferredNameShortName	String	True		The abbreviated name that corresponds to the preferred name record. This field provides a concise label for dashboards and HR reports.
PersonPreferredNameNickName	String	True		The nickname or informal name that is associated with the worker's preferred name. This field supports internal communication preferences and workforce personalization.
PersonPreferredNamePreferredSalutations	String	True		The preferred salutations that are associated with the worker's preferred name (for example, Mr., Ms., or Dr.). This field defines how the worker is addressed in preferred or informal contexts.
PersonPreferredNameQualificationAffixCode	String	True		The code that identifies the qualification affix associated with the worker's preferred name (for example, CPA, MBA, or PhD). This field supports credential display and professional recognition.
PersonPreferredNameQualificationAffixLongName	String	True		The full descriptive name of the code for the qualification affix of the worker's preferred name. This field provides the complete label that appears in HR and credential verification systems.
PersonPreferredNameQualificationAffixShortName	String	True		The abbreviated name that corresponds to code of the qualification affix of the worker's preferred name. This field provides a concise label for dashboards and workforce analytics.
PersonPreferredNameScriptCode	String	True		The code that identifies the script that is used to display the worker's preferred name (for example, Latin, Cyrillic, or Kanji). This field supports multilingual HR systems and international employee records.
PersonPreferredNameScriptLongName	String	True		The full descriptive name of the script code that is used to display the worker's preferred name. This field provides the complete label that appears in HR documentation and international employee records.
PersonPreferredNameScriptShortName	String	True		The abbreviated name that corresponds to the script code for the worker's preferred name. This field provides a concise label for dashboards, multilingual directories, and HR reports.
PersonPreferredNameTitleAffixCodes	String	True		The title affix codes that are associated with the worker's preferred name (for example, Dr., Prof., or Hon.). This field supports accurate name formatting for professional and formal communication.
PersonPreferredNameTitlePrefixCodes	String	True		The title prefix codes that are associated with the worker's preferred name (for example, Mr., Ms., or Rev.). This field defines how the worker's preferred name is presented in correspondence and records.
PersonReligionCode	String	True		The code that identifies the worker's religion or belief system as voluntarily disclosed. This field supports diversity, inclusion, and compliance initiatives in HR systems.
PersonReligionLongName	String	True		The full descriptive name of the religion code. This field provides the complete label that appears in HR documentation, inclusion analytics, and workforce diversity reports.
PersonReligionShortName	String	True		The abbreviated name that corresponds to the religion code. This field provides a concise label for dashboards, reports, and HR analytics.
PersonResidencyCountryCodes	String	True		The list of country codes that identify the countries where the worker holds legal residency. This field supports immigration tracking, payroll compliance, and tax jurisdiction reporting.
PersonSexualOrientationCode	String	True		The code that identifies the worker's sexual orientation as voluntarily disclosed. This field supports inclusion, diversity analytics, and HR compliance reporting.
PersonSexualOrientationLongName	String	True		The full descriptive name of the sexual orientation code. This field provides the complete label that appears in HR documentation and diversity reports.
PersonSexualOrientationShortName	String	True		The abbreviated name that corresponds to the sexual orientation code. This field provides a concise label for dashboards, workforce analytics, and compliance summaries.
PersonSocialInsurancePrograms	String	True		The list of social insurance programs that are associated with the worker (for example, Social Security, Unemployment Insurance, or Pension Plan). This field supports benefits administration and government compliance reporting.
PersonStudentIndicator	Boolean	True		The indicator that specifies whether the worker is currently a student. This field supports benefits eligibility, tax status verification, and workforce analytics.
PersonStudentStatusCode	String	True		The code that identifies the worker's student status (for example, Full-Time, Part-Time, or Graduate). This field supports payroll taxation and compliance reporting.
PersonStudentStatusEffectiveDate	Date	True		The date when the worker's student status became effective. This field supports accurate recordkeeping for benefits and educational assistance programs.
PersonStudentStatusLongName	String	True		The full descriptive name of the worker's student-status code. This field provides the complete label that appears in HR documentation and workforce analytics.
PersonStudentStatusShortName	String	True		The abbreviated name that corresponds to the worker's student-status code. This field provides a concise label for dashboards, reports, and HR analytics.
PersonTobaccoUserIndicator	Boolean	True		The indicator that specifies whether the worker has self-identified as a tobacco user. This field supports health benefits eligibility and wellness program administration.
PersonWorkAuthorizationDocuments	String	True		The set of work authorization documents that are associated with the worker (for example, Employment Authorization Card, Visa, or Residency Permit). This field supports eligibility verification and compliance with labor regulations.
Links	String	True		The collection of hyperlinks that connect this worker record to related HR data entities. This field supports record linkage, navigation, and integration across HR modules.
AsOfDate	Date	True		The effective date that defines when the worker's record information is valid. This field supports point-in-time reporting and compliance audits.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
PayrollGroupCode	String	The code that identifies the payroll group to which the worker belongs. This field is used during record insertion to assign payroll configuration settings.
OnboardingTemplateCode	String	The code that identifies the onboarding template that is assigned to the worker. This field is used during record insertion to initiate the correct onboarding workflow.
OnboardingTemplateCodeName	String	The name of the onboarding template that is assigned to the worker. This field provides descriptive context during onboarding record creation.
OnboardingStatusCode	String	The code that identifies the worker's onboarding status (for example, Pending, Completed, or Canceled). This field is used during record insertion to reflect onboarding progress.
OnboardingStatusCodeName	String	The name of the onboarding-status code that is assigned to the worker. This field provides a descriptive label for hire status tracking during record insertion.
HireReasonCode	String	The code that identifies the reason for hiring the worker (for example, New Hire, Rehire, or Internal Transfer). This field is used during record insertion to document HR process activity.
HireReasonCodeName	String	The name of the hire-reason code that is assigned to the worker. This field provides a descriptive label for the corresponding hire action during record insertion.

WorkersPersonCommunicationEmails

The table that stores personal email communication data for workers. This table includes primary and alternate personal email addresses that are maintained in Human Resources (HR) systems for contact and verification purposes.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonCommunicationEmails WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonCommunicationEmails WHERE AsOfDate = '2020-01-01'

Update

Following is an example of how to Update a WorkersPersonCommunicationEmails table:

UPDATE WorkersPersonCommunicationEmails SET EmailUri = 'test@test.com' WHERE AssociateOID = 'G3349PZGBADQY8H8'

Columns


Name	Type	ReadOnly	References	Description
AssociateOID [KEY]	String	False	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the personal email record to the correct worker profile.
WorkerID	String	True	Workers.WorkerID	The Id that identifies the worker associated with this personal email address. This field ensures proper linkage between worker records and contact details across HR and communication systems.
EmailUri	String	False		The email address that is assigned to or provided by the worker for personal or HR-related communication. This field supports notification delivery, employee correspondence, and contact record accuracy.
ItemID	String	True		The Id that uniquely identifies the email-address record. This field supports version control, auditing, and historical tracking of communication information within HR data systems.
NameCode	String	True		The code that categorizes the type or purpose of the email address (for example, Personal, Work, or Alternate). This field supports structured communication management and HR classification.
NameCodeLongName	String	True		The full descriptive name of the code for the email type. This field provides the complete label that is displayed in HR records and reports.
NameCodeShortName	String	True		The abbreviated name that corresponds to the code for the email type. This field provides a concise label for HR dashboards, exports, and user interfaces.
NotificationIndicator	Boolean	True		The indicator that specifies whether this email address is used for automatic HR notifications (for example, onboarding messages, policy updates, or pay alerts).
AsOfDate	Date	True		The date that defines when this email-address record became effective. This field supports HR data auditing, historical accuracy, and compliance management.

WorkersPersonCommunicationFaxes

The table that stores personal fax contact data for workers. This table preserves personal fax information for employees in cases where legacy communication records must be retained for compliance.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonCommunicationFaxes WHERE AsOfDate = '2020-01-01'

Update

Following is an example of how to Update a WorkersPersonCommunicationFaxes table:

UPDATE WorkersPersonCommunicationFaxes SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'

Columns


Name	Type	ReadOnly	References	Description
AssociateOID [KEY]	String	False	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the personal fax record to the correct worker profile.
WorkerID	String	True	Workers.WorkerID	The Id that identifies the worker associated with this fax number. This field ensures accurate linkage between worker records and personal communication details across HR systems.
Access	String	False		The access type that defines how the fax number can be used (for example, Internal, External, or Restricted). This field supports security and communication governance within HR systems.
AreaDialing	String	False		The area dialing code that is used for the worker's personal fax number. This field supports regional dialing compliance and proper routing of communication.
CountryDialing	String	False		The country dialing code that is used for the worker's personal fax number. This field ensures international dialing accuracy and supports cross-border communication management.
DialNumber	String	False		The fax number that is assigned to the worker for personal or HR-related correspondence. This field supports documentation exchange and compliance communication processes.
Extension	String	False		The fax extension number that is assigned for routing or department-level delivery. This field supports accurate document transmission and HR record routing.
FormattedNumber	String	True		The fully formatted version of the worker's fax number. This field ensures consistent presentation across HR records, forms, and communication outputs.
ItemID	String	True		The Id that uniquely identifies the fax record. This field supports version control, data lineage, and historical recordkeeping within HR systems.
NameCode	String	True		The code that categorizes the type or purpose of the fax number (for example, Personal, Emergency, or Alternate). This field supports structured contact classification across HR and compliance records.
NameCodeLongName	String	True		The full descriptive name of the code for the fax type. This field provides the complete name that appears in HR documentation and exported reports.
NameCodeShortName	String	True		The abbreviated name that corresponds to the code of the fax type. This field supports compact display in HR dashboards, forms, and data exports.
NotificationIndicator	Boolean	True		The indicator that specifies whether this fax number is used for automated HR notifications or formal correspondence (for example, policy updates or benefits documentation).
AsOfDate	Date	True		The date that defines when this fax record became effective. This field supports compliance verification, auditing, and historical data tracking within HR systems.

WorkersPersonCommunicationLandlines

The table that stores personal landline contact information for workers. This table includes residential phone numbers that are maintained in Human Resources (HR) profiles for emergency or verification purposes.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonCommunicationLandlines WHERE AsOfDate = '2020-01-01'

Update

Following is an example of how to Update a WorkersPersonCommunicationLandlines table:

UPDATE WorkersPersonCommunicationLandlines SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'

Columns


Name	Type	ReadOnly	References	Description
AssociateOID [KEY]	String	False	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the personal landline record to the correct worker profile.
WorkerID	String	True	Workers.WorkerID	The Id that identifies the worker associated with this personal landline number. This field ensures consistent linkage between worker records and communication details across HR systems.
Access	String	False		The access type that defines how the landline number can be used (for example, Internal, External, or Restricted). This field supports communication access control and HR policy compliance.
AreaDialing	String	False		The area dialing code that is used for the worker's landline number. This field supports geographic identification and regional dialing accuracy in HR contact management.
CountryDialing	String	False		The country dialing code that is used for the worker's landline number. This field ensures international dialing compliance and supports accurate routing of calls across regions.
DialNumber	String	False		The primary landline number that is assigned to the worker for personal or HR-related use. This field supports employee contact, verification, and formal HR communication processes.
Extension	String	False		The landline extension number that is used for departmental or office-level routing. This field supports structured contact management and communication efficiency within HR systems.
FormattedNumber	String	True		The fully formatted version of the worker's landline number. This field ensures consistency in data presentation across HR records, reports, and communication templates.
ItemID	String	True		The Id that uniquely identifies the landline record. This field supports version control, historical recordkeeping, and data integrity within HR systems.
NameCode	String	True		The code that categorizes the type or purpose of the landline number (for example, Personal, Home, or Alternate). This field supports structured classification and HR data organization.
NameCodeLongName	String	True		The full descriptive name of the type code for the landline. This field provides the complete label that appears in HR documentation and exported data sets.
NameCodeShortName	String	True		The abbreviated name that corresponds to the type code of the landline. This field provides a concise label for dashboards, HR interfaces, and summary reports.
NotificationIndicator	Boolean	True		The indicator that specifies whether this landline number is used for automated HR notifications (for example, alert messages, verification calls, or onboarding updates).
AsOfDate	Date	True		The date that defines when this landline record became effective. This field supports time-based data auditing, compliance tracking, and HR record accuracy.

WorkersPersonCommunicationMobiles

The table that stores personal mobile phone contact information for workers. This table supports Human Resources (HR) communications, emergency alerts, and verification processes requiring mobile contact access.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonCommunicationMobiles WHERE AsOfDate = '2020-01-01'

Update

Following is an example of how to Update a WorkersPersonCommunicationMobiles table:

UPDATE WorkersPersonCommunicationMobiles SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'

Columns


Name	Type	ReadOnly	References	Description
AssociateOID [KEY]	String	False	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the mobile phone record to the correct worker profile.
WorkerID	String	True	Workers.WorkerID	The Id that identifies the worker associated with this personal mobile phone number. This field ensures consistent linkage between the worker record and contact information across HR systems.
Access	String	False		The access type that defines how the mobile number can be used (for example, Internal, External, or Restricted). This field supports security, access governance, and HR communication policies.
AreaDialing	String	False		The area dialing code that is used for the worker's mobile phone number. This field supports accurate regional identification and dialing consistency within HR contact systems.
CountryDialing	String	False		The country dialing code that is used for the worker's mobile phone number. This field ensures international dialing accuracy and supports cross-border HR communication compliance.
DialNumber	String	False		The primary mobile phone number that is assigned to or provided by the worker for personal or HR-related communication. This field supports direct outreach, alerts, and verification processes.
Extension	String	False		The mobile extension number that is assigned for internal routing or departmental use. This field supports communication efficiency and HR coordination within distributed organizations.
FormattedNumber	String	True		The fully formatted version of the worker's mobile phone number. This field ensures consistency across HR systems, communication directories, and exported data.
ItemID	String	True		The Id that uniquely identifies the mobile phone record. This field supports auditing, version tracking, and historical recordkeeping within HR systems.
NameCode	String	True		The code that categorizes the purpose or type of mobile number (for example, Personal, Primary, or Alternate). This field supports structured contact classification across HR records.
NameCodeLongName	String	True		The full descriptive name of the type code for the mobile number. This field provides the complete label that appears in HR documentation and reporting tools.
NameCodeShortName	String	True		The abbreviated name that corresponds to the type code of the mobile number. This field supports compact display in HR dashboards, reports, and interfaces.
NotificationIndicator	Boolean	True		The indicator that specifies whether this mobile phone number is used for automated HR notifications (for example, shift alerts, policy messages, or emergency updates).
AsOfDate	Date	True		The date that defines when this mobile phone record became effective. This field supports historical validation, auditing, and HR data accuracy.

WorkersPersonCommunicationPagers

The table that stores personal pager communication data for workers. This table retains historical pager information that can be required for compliance review or archival purposes.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonCommunicationPagers WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonCommunicationPagers WHERE AsOfDate = '2020-01-01'

Update

Following is an example of how to Update a WorkersPersonCommunicationPagers table:

UPDATE WorkersPersonCommunicationPagers SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'

Columns


Name	Type	ReadOnly	References	Description
AssociateOID [KEY]	String	False	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the personal pager record to the correct worker profile.
WorkerID	String	True	Workers.WorkerID	The Id that identifies the worker associated with this pager number. This field ensures accurate linkage between the worker's personal contact information and HR data records.
Access	String	False		The access type that defines how the pager number can be used (for example, Internal, External, or Restricted). This field supports secure communication access management within HR systems.
AreaDialing	String	False		The area dialing code that is used for the worker's pager number. This field supports proper regional dialing and routing across communication networks.
CountryDialing	String	False		The country dialing code that is used for the worker's pager number. This field ensures international dialing compliance and accurate routing for global HR communication.
DialNumber	String	False		The pager number that is assigned to the worker for personal or HR-related communication. This field supports emergency contact, shift alerts, and business continuity operations.
Extension	String	False		The pager extension number that is assigned for department or location-based routing. This field supports communication precision within organizational workflows.
FormattedNumber	String	True		The fully formatted version of the worker's pager number. This field ensures consistent presentation across HR databases, directories, and reporting tools.
ItemID	String	True		The Id that uniquely identifies the pager record. This field supports auditing, version tracking, and historical recordkeeping within HR systems.
NameCode	String	True		The code that categorizes the purpose or type of pager number (for example, Personal, Emergency, or Alternate). This field supports structured contact classification within HR communication records.
NameCodeLongName	String	True		The full descriptive name of the pager type code. This field provides the complete label that appears in HR documentation and formal reports.
NameCodeShortName	String	True		The abbreviated name that corresponds to the pager type code. This field supports concise labeling in HR dashboards, data exports, and user interfaces.
NotificationIndicator	Boolean	True		The indicator that specifies whether this pager number is used for automated HR notifications (for example, system alerts, emergency messages, or status updates).
AsOfDate	Date	True		The date that defines when this pager record became effective. This field supports version control, time-based auditing, and HR compliance tracking.

WorkersWorkAssignments

The table that stores comprehensive information about worker assignments. This table includes assignment Ids, job roles, departments, and reporting relationships. This table forms the foundation for payroll, scheduling, and Human Resources (HR) analytics.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerIdValue supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignments WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignments WHERE WorkerIdValue = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignments WHERE AsOfDate = '2020-01-01'

Update

Following is an example of how to Update BaseRemuneration:

UPDATE WorkersWorkAssignments SET StandardHoursQuantity = '45', BaseRemunerationEffectiveDate = '2020-12-21', PayCycleCodeValue = '4', BaseRemunerationHourlyRateAmountValue = 300, WageLawCoverageCodeValue = 'N', BaseRemunerationCode = 'ADJ', ItemId = '34321368N' WHERE AssociateOID = 'G3GMC21PJFZT7K4F'

Following is an example of how to Update AdditionalRemuneration using aggregates:

UPDATE WorkersWorkAssignments SET AdditionalRemunerations = '[{"remunerationTypeCode":{"code":"AE","name":"additional earnings"},"remunerationRate":{"rate":70,"currencyCode":"USD"},"effectiveDate":"2020-12-20","nameCode":{"code":"1FA"},"inactiveIndicator":false}]', itemid = '35777493N' WHERE AssociateOID = 'G3TGG0M57JZEXCP1'

Following is an example of how to Update AdditionalRemuneration using Temp Table:

INSERT INTO Input_AdditionalRemunerations#TEMP (RemunerationTypeCode, RemunerationRate, RemunerationCurrencyCode, effectiveDate, NameCode, InactiveIndicator) VALUES ('AE', '70', 'USD', '2021-01-04', 'R', false)

UPDATE WorkersWorkAssignments SET AdditionalRemunerations = 'Input_AdditionalRemunerations#TEMP', itemid = '35777493N' WHERE AssociateOID = 'G3TGG0M57JZEXCP1'

Following is an example of how to Update Worker Assignment Termination:

UPDATE WorkersWorkAssignments SET TerminationDate = '2020-01-31', LastWorkedDate = '2020-01-31', AssignmentStatusReasonCodeValue = 'A00', RehireEligibleIndicator = true, SeveranceEligibleIndicator = true, TerminationComments = 'Looking for better growth and oppurtunities', itemid = '00691088N' WHERE AssociateOID = 'G3TGG0M57JZECKRB'

Following is an example of how to Update Worker Type:

UPDATE WorkersWorkAssignments SET WorkerTypeCodeValue = 'F', ItemId = '31095304_1668', EventReasonCode = 'ADL', EffectiveDate = '2021-01-01' WHERE AssociateOID = 'G3Q8G47NKHBV1SMT'

Columns


Name	Type	ReadOnly	References	Description
AssociateOID [KEY]	String	True	Workers.AssociateOID	The unique identifier (Id) that represents the associate within the HR system. This field links the work assignment record to the associate's overall employment profile.
WorkerIdValue	String	True	Workers.WorkerID	The identifier value that represents the worker within HR and payroll systems. This field supports data synchronization and compliance tracking across systems.
ItemID [KEY]	String	False		The unique identifier (Id) that represents the specific work-assignment record. This field supports HR data auditing, history tracking, and reference linking to related tables.
ActualStartDate	Date	True		The date that defines when the worker actually began the assignment. This field supports HR onboarding validation, benefits eligibility, and payroll activation processes.
CompaRatio	Integer	True		The computed compensation ratio that compares the worker's pay to the midpoint of the assigned pay range. This field supports compensation analysis and equity reporting.
AdditionalRemunerations	String	False		The additional remuneration components associated with the worker's assignment (for example, bonuses, commissions, or allowances). This field supports detailed payroll and compensation reporting.
AnnualBenefitBaseRateAmountValue	Integer	True		The annual monetary value that defines the worker's base rate for benefit calculations. This field supports HR benefits administration and total rewards reporting.
AnnualBenefitBaseRateCurrencyCode	String	True		The currency code that defines the denomination of the annual benefit base rate (for example, USD, CAD, or EUR). This field ensures currency consistency across HR and payroll systems.
AnnualBenefitBaseRateNameCodeValue	String	True		The code that identifies the classification of the annual benefit base rate. This field supports HR and payroll benefit mapping and financial compliance.
AnnualBenefitBaseRateNameCodeLongName	String	True		The full descriptive name of the annual benefit base rate code. This field provides the complete label used in HR benefits and payroll documentation.
AnnualBenefitBaseRateNameCodeShortName	String	True		The abbreviated name that corresponds to the annual benefit base rate code. This field supports compact reporting and data display in HR dashboards.
AssignedOrganizationalUnits	String	False		The organizational units that are assigned to the worker's current position (for example, Department, Division, or Business Unit). This field supports HR structure management and cost center allocation.
AssignedWorkLocations	String	True		The locations that are assigned to the worker's current role (for example, Office, Plant, or Region). This field supports HR workforce planning and location-based compliance tracking.
AssignmentCostCenters	String	True		The cost centers that are linked to the worker's assignment. This field supports HR budgeting, payroll accounting, and financial reporting.
AssignmentStatusEffectiveDate	Date	True		The date that defines when the current assignment status became effective. This field supports HR history tracking and payroll processing accuracy.
AssignmentStatusReasonCodeValue	String	False		The code that identifies the reason for a change in assignment status (for example, Promotion, Transfer, or Termination). This field supports HR audit trail creation and compliance documentation.
AssignmentStatusReasonCodeLongName	String	True		The full descriptive name of the reason code for the assignment status. This field provides clarity in HR records and internal reporting.
AssignmentStatusReasonCodeShortName	String	True		The abbreviated name that corresponds to the reason code for the assignment status. This field supports compact display in HR reports and dashboards.
AssignmentStatusStatusCodeValue	String	True		The code that identifies the current status of the worker's assignment (for example, Active, On Leave, or Terminated). This field supports HR and payroll status validation.
AssignmentStatusStatusCodeLongName	String	True		The full descriptive name of the assignment status code. This field provides the detailed label used in HR documentation and status reports.
AssignmentStatusStatusCodeShortName	String	True		The abbreviated name that corresponds to the assignment status code. This field supports concise labeling in HR dashboards and compliance exports.
AssignmentTermCodeValue	String	True		The code that identifies the term or duration type of the worker's assignment (for example, Permanent, Temporary, or Seasonal). This field supports HR classification and contract tracking.
AssignmentTermCodeLongName	String	True		The full descriptive name of the assignment term code. This field provides the complete label used in HR reports and payroll documentation.
AssignmentTermCodeShortName	String	True		The abbreviated name that corresponds to the assignment term code. This field supports compact data presentation in HR dashboards and reports.
BargainingUnitBargainingUnitCodeValue	String	False		The code that identifies the bargaining unit to which the worker belongs. This field supports HR union management and collective bargaining compliance tracking.
BargainingUnitBargainingUnitCodeLongName	String	True		The full descriptive name of the bargaining unit code. This field provides context for HR labor relations and payroll reporting.
BargainingUnitBargainingUnitCodeShortName	String	False		The abbreviated name that corresponds to the bargaining unit code. This field supports compact reporting and streamlined HR data display.
BargainingUnitSeniorityDate	Date	False		The date that defines when the worker's seniority within the bargaining unit began. This field supports HR union reporting and benefit eligibility tracking.
BaseRemunerationAnnualRateAmountValue	Decimal	True		The monetary value of the worker's annual base remuneration. This field supports HR compensation planning, payroll calculation, and equity analysis.
BaseRemunerationAnnualRateAmountCurrencyCode	String	True		The currency code that defines the denomination of the annual base remuneration (for example, USD, GBP, or AUD). This field supports HR and payroll system integration.
BaseRemunerationAnnualRateAmountNameCodeValue	String	True		The code that identifies the classification of the annual remuneration type. This field supports structured pay configuration and HR compensation mapping.
BaseRemunerationAnnualRateAmountNameCodeLongName	String	True		The full descriptive name of the type code for the annual remuneration. This field provides the detailed label that appears in HR documentation and payroll reports.
BaseRemunerationAnnualRateAmountNameCodeShortName	String	True		The abbreviated name that corresponds to the type code for the annual remuneration. This field supports concise labeling in HR dashboards and compensation summaries.
BaseRemunerationAssociatedRateQualifiers	String	True		The rate qualifiers that are associated with the worker's base remuneration (for example, Hourly, Annualized, or Commission-based). This field supports payroll configuration and HR data mapping.
BaseRemunerationBiweeklyRateAmountValue	Decimal	True		The monetary value of the worker's biweekly base remuneration. This field supports payroll processing, labor cost tracking, and HR compensation analysis.
BaseRemunerationBiweeklyRateAmountCurrencyCode	String	True		The currency code that defines the denomination of the biweekly base remuneration (for example, USD, CAD, or EUR). This field supports currency consistency across HR and payroll systems.
BaseRemunerationBiweeklyRateAmountNameCodeLongName	String	True		The full descriptive name of the type code for the biweekly remuneration. This field provides the detailed label that appears in HR documentation and reports.
BaseRemunerationBiweeklyRateAmountNameCodeValue	String	True		The code that identifies the classification of the biweekly remuneration type. This field supports structured compensation tracking and HR data integration.
BaseRemunerationBiweeklyRateAmountNameCodeShortName	String	True		The abbreviated name that corresponds to the the type code for the biweekly remuneration. This field supports compact data display in HR dashboards and compensation exports.
BaseRemunerationCommissionRatePercentageBaseUnitCodeValue	String	True		The code that identifies the base unit that is used to calculate commission rate percentages (for example, Sales Amount, Units Sold, or Revenue). This field supports commission calculations and HR compensation reporting.
BaseRemunerationCommissionRatePercentageBaseUnitCodeLongName	String	True		The full descriptive name of the code for the commission-rate base unit. This field provides a human-readable label for HR compensation and commission reports.
BaseRemunerationCommissionRatePercentageBaseUnitCodeShortName	String	True		The abbreviated form of the code for the commission-rate base unit. This field supports compact display in HR dashboards and payroll exports.
BaseRemunerationCommissionRatePercentageNameCodeValue	String	True		The code that identifies the type of commission rate applied to the worker's compensation. This field supports structured HR and payroll data integration.
BaseRemunerationCommissionRatePercentageNameCodeLongName	String	True		The full descriptive name of the type code for the commission-rate percentage. This field provides the complete label that appears in HR documentation and payroll reports.
BaseRemunerationCommissionRatePercentageNameCodeShortName	String	True		The abbreviated name that corresponds to the the type code for the commission-rate percentage. This field supports compact display in HR dashboards and exports.
BaseRemunerationCommissionRatePercentagePercentageValue	Integer	True		The numeric percentage that represents the commission rate applied to the worker's earnings. This field supports payroll computation and HR compensation analysis.
BaseRemunerationDailyRateAmountValue	Decimal	False		The monetary value of the worker's daily base remuneration. This field supports payroll calculation, HR budgeting, and compensation planning.
BaseRemunerationDailyRateAmountCurrencyCode	String	True		The currency code that defines the denomination of the daily base remuneration (for example, USD, GBP, or CAD). This field supports payroll accuracy and cross-border HR reporting.
BaseRemunerationDailyRateAmountNameCodeValue	String	False		The code that identifies the classification of the daily remuneration type. This field supports structured compensation mapping and HR data standardization.
BaseRemunerationDailyRateAmountNameCodeLongName	String	True		The full descriptive name of the type code for the daily remuneration. This field provides context for HR compensation records and payroll documentation.
BaseRemunerationDailyRateAmountNameCodeShortName	String	True		The abbreviated name that corresponds to the type code for the daily remuneration. This field supports concise labeling in HR dashboards and data exports.
BaseRemunerationEffectiveDate	Date	False		The date that defines when the worker's base remuneration became effective. This field supports payroll accuracy, HR auditing, and historical tracking.
BaseRemunerationHourlyRateAmountValue	Decimal	False		The monetary value of the worker's hourly base remuneration. This field supports HR compensation management, payroll calculation, and compliance reporting.
BaseRemunerationHourlyRateAmountCurrencyCode	String	True		The currency code that defines the denomination of the hourly base remuneration (for example, USD, EUR, or GBP). This field ensures alignment between HR and payroll systems.
BaseRemunerationHourlyRateAmountNameCodeValue	String	True		The code that identifies the classification of the hourly remuneration type. This field supports structured data mapping and HR pay configuration.
BaseRemunerationHourlyRateAmountNameCodeLongName	String	True		The full descriptive name of the type code for th hourly remuneration. This field provides the detailed label used in HR compensation documentation and payroll reports.
BaseRemunerationHourlyRateAmountNameCodeShortName	String	True		The abbreviated name that corresponds to the type code for the hourly remuneration. This field supports compact display in HR dashboards and system exports.
BaseRemunerationMonthlyRateAmountValue	Decimal	True		The monetary value of the worker's monthly base remuneration. This field supports payroll cycle processing, HR compensation planning, and internal reporting.
BaseRemunerationMonthlyRateAmountCurrencyCode	String	True		The currency code that defines the denomination of the monthly base remuneration (for example, USD, CAD, or AUD). This field supports HR and payroll integration for accurate compensation management.
BaseRemunerationMonthlyRateAmountNameCodeValue	String	False		The code that identifies the classification of the monthly remuneration type. This field supports structured HR pay configuration and payroll reporting.
BaseRemunerationMonthlyRateAmountNameLongName	String	True		The full descriptive name of the type code for the monthly remuneration. This field provides the detailed label used in HR documentation and compensation reports.
BaseRemunerationMonthlyRateAmountNameShortName	String	False		The abbreviated name that corresponds to the type code for the monthly remuneration. This field supports compact data display in HR dashboards and exports.
BaseRemunerationPayPeriodRateAmountValue	Decimal	True		The monetary value of the worker's pay-period base remuneration. This field supports HR compensation planning, payroll calculation, and earnings reporting.
BaseRemunerationPayPeriodRateAmountCurrencyCode	String	True		The currency code that defines the denomination of the pay-period base remuneration (for example, USD, EUR, or CAD). This field ensures consistency between HR and payroll systems.
BaseRemunerationPayPeriodRateAmountNameCodeValue	String	True		The code that identifies the classification of the pay-period remuneration type. This field supports structured HR and payroll data mapping.
BaseRemunerationPayPeriodRateAmountNameCodeLongName	String	True		The full descriptive name of the code for the pay-period remuneration type. This field provides a human-readable label used in HR documentation and payroll reports.
BaseRemunerationPayPeriodRateAmountNameCodeShortName	String	True		The abbreviated name that corresponds to the code for the pay-period remuneration type. This field supports compact reporting in HR dashboards and compensation exports.
BaseRemunerationRecordingBasisCodeValue	String	True		The code that identifies the basis used for recording remuneration (for example, Cash, Accrual, or Commission-based). This field supports HR accounting compliance and payroll configuration.
BaseRemunerationRecordingBasisCodelongName	String	True		The full descriptive name of the code fro the remuneration recording basis. This field provides context for HR reporting, payroll auditing, and accounting integration.
BaseRemunerationRecordingBasisCodeShortName	String	True		The abbreviated name that corresponds to the code for the remuneration recording basis. This field supports concise labeling in HR dashboards and internal payroll reports.
BaseRemunerationSemiMonthlyRateAmountValue	Decimal	True		The monetary value of the worker's semi-monthly base remuneration. This field supports HR compensation analysis and payroll cycle management.
BaseRemunerationSemiMonthlyRateAmountCurrencyCode	String	True		The currency code that defines the denomination of the semi-monthly base remuneration (for example, USD, GBP, or AUD). This field supports cross-border HR and payroll consistency.
BaseRemunerationSemiMonthlyRateAmountNameCodeValue	String	True		The code that identifies the classification of the semi-monthly remuneration type. This field supports structured compensation management in HR systems.
BaseRemunerationSemiMonthlyRateAmountNameCodeLongName	String	True		The full descriptive name of the code for the semi-monthly remuneration type. This field provides the detailed label that appears in HR documentation and payroll reports.
BaseRemunerationSemiMonthlyRateAmountNameCodeShortName	String	True		The abbreviated name that corresponds to the code for the semi-monthly remuneration type. This field supports compact data representation in HR and payroll exports.
BaseRemunerationWeeklyRateAmountValue	Decimal	True		The monetary value of the worker's weekly base remuneration. This field supports payroll cycle processing, HR budgeting, and compensation analysis.
BaseRemunerationWeeklyRateAmountCurrencyCode	String	True		The currency code that defines the denomination of the weekly base remuneration (for example, USD, CAD, or EUR). This field ensures HR and payroll system alignment.
BaseRemunerationWeeklyRateAmountNameCodeValue	String	True		The code that identifies the classification of the weekly remuneration type. This field supports structured HR data mapping and compensation reporting.
BaseRemunerationWeeklyRateAmountNameCodeLongName	String	True		The full descriptive name of the code for the weekly remuneration type. This field provides context for HR documentation and payroll analysis.
BaseRemunerationWeeklyRateAmountNameCodeShortName	String	True		The abbreviated name that corresponds to the code for the weekly remuneration type. This field supports compact display in HR dashboards and internal payroll reports.
ExecutiveIndicator	Boolean	True		A Boolean value that indicates whether the worker is classified as an executive. This field supports HR workforce segmentation, compensation policy enforcement, and compliance tracking.
ExecutiveTypeCodeValue	String	True		The code that identifies the type of executive classification (for example, C-Level, Vice President, or Senior Director). This field supports HR categorization and compensation management.
ExecutiveTypeCodeLongName	String	True		The full descriptive name of the code for the executive type. This field provides the human-readable label used in HR and payroll documentation.
ExecutiveTypeCodeShortName	String	True		The abbreviated name that corresponds to the code for the executive type. This field supports compact HR and payroll data display.
ExpectedStartDate	Date	True		The date that defines when the worker's assignment is expected to begin. This field supports HR onboarding scheduling, payroll activation, and resource planning.
ExpectedTerminationDate	Date	True		The date that defines when the worker's assignment is expected to end. This field supports HR contract management, payroll forecasting, and offboarding coordination.
FullTimeEquivalenceRatio	Integer	True		The numeric ratio that represents the worker's full-time equivalence (FTE). This field supports HR analytics, payroll budgeting, and compliance reporting for part-time and full-time employees.
GeographicPayDifferentialCodeValue	String	True		The code that identifies the geographic pay differential category that is applied to the worker's pay. This field supports HR regional compensation management and pay equity analysis.
GeographicPayDifferentialCodeLongName	String	True		The full descriptive name of the geographic pay differential code. This field provides context in HR compensation documentation and payroll records.
GeographicPayDifferentialCodeShortName	String	True		The abbreviated name that corresponds to the geographic pay differential code. This field supports compact labeling in HR dashboards and compensation exports.
GeographicPayDifferentialPercentage	Integer	True		The numeric percentage that represents the pay differential applied to the worker based on geographic location. This field supports payroll accuracy and HR compensation analysis.
HighlyCompensatedIndicator	Boolean	True		A Boolean value that indicates whether the worker qualifies as a highly compensated employee. This field supports HR compliance reporting and compensation eligibility validation.
HighlyCompensatedTypeCodeValue	String	True		The code that identifies the type of highly compensated employee classification (for example, Exempt Executive, Exempt Professional, or Exempt Administrative). This field supports HR classification and compliance reporting.
HighlyCompensatedTypeCodeLongName	String	True		The full descriptive name of the highly compensated classification code. This field provides clarity in HR documentation and compensation analysis.
HighlyCompensatedTypeCodeShortName	String	True		The abbreviated name that corresponds to the highly compensated classification code. This field supports compact data presentation in HR dashboards and payroll reports.
HireDate	Date	True		The date that defines when the worker was originally hired for the assignment. This field supports HR tenure tracking, benefits eligibility, and payroll activation.
HomeOrganizationalUnits	String	False		The organizational units that are designated as the worker's home units (for example, Department, Division, or Cost Center). This field supports HR organizational mapping and payroll cost allocation.
HomeWorkLocationAddressAttentionOfName	String	True		The name of the person or department that correspondence to the worker's home work location should be addressed to. This field supports HR facility management and internal communication routing.
HomeWorkLocationAddressBlockName	String	True		The name or identifier of the block associated with the worker's home work-location address. This field supports HR address accuracy, facility mapping, and emergency contact documentation.
HomeWorkLocationAddressBuildingName	String	True		The name of the building where the worker's home work location is situated. This field supports HR facility identification, correspondence accuracy, and workplace safety planning.
HomeWorkLocationAddressBuildingNumber	String	True		The number that identifies the specific building associated with the worker's home work location. This field supports HR address standardization and postal delivery accuracy.
HomeWorkLocationAddressCareOfName	String	True		The name of the person or entity designated as 'care of' for the worker's home work-location address. This field supports HR record accuracy and ensures correspondence reaches the correct contact.
HomeWorkLocationAddressCityName	String	False		The name of the city where the worker's home work location is located. This field supports HR compliance, payroll tax jurisdiction assignment, and location-based reporting.
HomeWorkLocationAddressCountryCode	String	False		The code that identifies the country where the worker's home work location is situated (for example, US, CA, or MX). This field supports HR global data mapping and payroll localization.
HomeWorkLocationAddressCountrySubdivisionLevel1CodeValue	String	False		The code that identifies the first-level administrative subdivision (for example, State, Province, or Region). This field supports HR jurisdictional reporting and compliance management.
HomeWorkLocationAddressCountrySubdivisionLevel1LongName	String	True		The full descriptive name of the first-level administrative subdivision. This field provides the formal label used in HR and payroll documentation.
HomeWorkLocationAddressCountrySubdivisionLevel1ShortName	String	False		The abbreviated name that corresponds to the first-level administrative subdivision. This field supports compact display in HR reports and system dashboards.
HomeWorkLocationAddressCountrySubdivisionLevel1SubdivisionType	String	False		The classification that defines the type of first-level administrative subdivision (for example, State, Province, or Territory). This field supports HR standardization and jurisdiction mapping.
HomeWorkLocationAddressCountrySubdivisionLevel2CodeValue	String	False		The code that identifies the second-level administrative subdivision (for example, County, Municipality, or District). This field supports HR geographic hierarchy and payroll location mapping.
HomeWorkLocationAddressCountrySubdivisionLevel2LongName	String	True		The full descriptive name of the second-level administrative subdivision. This field provides the detailed label used in HR reports and address documentation.
HomeWorkLocationAddressCountrySubdivisionLevel2ShortName	String	False		The abbreviated name that corresponds to the second-level administrative subdivision. This field supports compact representation in HR dashboards and exported data.
HomeWorkLocationAddressCountrySubdivisionLevel2SubdivisionType	String	False		The classification that defines the type of second-level administrative subdivision (for example, County, District, or Municipality). This field supports HR and payroll location configuration.
HomeWorkLocationAddressDeliveryPoint	String	True		The specific delivery point that defines the precise postal destination for the worker's home work-location address (for example, Suite, Apartment, or Mailstop). This field supports HR correspondence and logistical accuracy.
HomeWorkLocationAddressDoor	String	True		The door or entryway identifier for the worker's home work location. This field supports HR facility access, emergency planning, and internal navigation.
HomeWorkLocationAddressFloor	String	True		The floor number or designation within the building at the worker's home work location. This field supports HR workplace mapping and safety coordination.
HomeWorkLocationAddressGeoCoordinateLatitude	Integer	True		The latitude coordinate that represents the worker's home work location. This field supports HR geolocation analysis, emergency planning, and workforce distribution tracking.
HomeWorkLocationAddressGeoCoordinateLongitude	Integer	True		The longitude coordinate that represents the worker's home work location. This field supports HR facility mapping, payroll region verification, and global compliance analytics.
HomeWorkLocationAddressLineFive	String	True		The fifth address line that provides additional details for the worker's home work-location address. This field supports full address documentation and HR correspondence completeness.
HomeWorkLocationAddressLineFour	String	True		The fourth address line used for secondary address components (for example, complex name or internal routing). This field supports detailed HR and facility address management.
HomeWorkLocationAddressLineOne	String	False		The first address line that identifies the main street address or premise information. This field supports HR legal documentation, payroll registration, and mailing accuracy.
HomeWorkLocationAddressLineTwo	String	False		The second address line that provides supplemental location information (for example, Apartment, Suite, or Unit). This field supports HR and payroll address validation.
HomeWorkLocationAddressLineThree	String	False		The third address line that provides further location details, such as complex or internal building identifiers. This field supports HR accuracy in employee and facility records.
HomeWorkLocationAddressNameCodeValue	String	True		The code that identifies the naming convention or category used for the home work-location address. This field supports HR address classification and system standardization.
HomeWorkLocationAddressNameCodeLongName	String	True		The full descriptive name of the home work-location address name code. This field provides the formal label used in HR reporting and payroll exports.
HomeWorkLocationAddressNameCodeShortName	String	True		The abbreviated name that corresponds to the home work-location address name code. This field supports compact data display in HR dashboards and export files.
HomeWorkLocationAddressPlotID	String	True		The plot identifier that represents the specific land parcel or property for the home work location. This field supports HR facility records, mapping, and legal compliance documentation.
HomeWorkLocationAddressPostalCode	String	False		The postal or ZIP code associated with the worker's home work location. This field supports HR and payroll jurisdictional reporting, taxation, and address validation.
HomeWorkLocationAddressPostOfficeBox	String	True		The post office box number linked to the worker's home work location, if applicable. This field supports HR correspondence management and postal recordkeeping.
HomeWorkLocationAddressScriptCodeValue	String	True		The code that identifies the character script used in the address (for example, Latin, Cyrillic, or Katakana). This field supports multilingual HR address formatting and system compatibility.
HomeWorkLocationAddressScriptCodeLongName	String	True		The full descriptive name of the address script code that defines the writing system used in the home work-location address (for example, Latin or Cyrillic). This field supports multilingual HR recordkeeping and system compatibility.
HomeWorkLocationAddressScriptCodeShortName	String	True		The abbreviated name that corresponds to the address script code. This field supports compact HR data display and international address formatting.
HomeWorkLocationAddressStairCase	String	True		The staircase identifier that defines a specific entry or section of the building associated with the worker's home work-location address. This field supports HR facility mapping, access management, and safety documentation.
HomeWorkLocationAddressStreetName	String	True		The name of the street where the worker's home work location is situated. This field supports HR address validation, payroll jurisdiction alignment, and mail accuracy.
HomeWorkLocationAddressStreetTypeCodeValue	String	True		The code that identifies the classification of the street type (for example, Avenue, Boulevard, or Road). This field supports HR address standardization and payroll region mapping.
HomeWorkLocationAddressStreetTypeCodeLongName	String	True		The full descriptive name of the type code for the street. This field provides clarity in HR and payroll address records for global consistency.
HomeWorkLocationAddressStreetTypeCodeShortName	String	True		The abbreviated name that corresponds to type code for the street. This field supports compact representation of address data in HR reports and exports.
HomeWorkLocationAddressUnit	String	True		The unit, apartment, or suite designation for the worker's home work location. This field supports HR address accuracy, facility contact tracking, and postal compliance.
HomeWorkLocationCommunicationEmails	String	True		The email contact details that are associated with the home work location (for example, site administrator, facilities desk, or local HR contact). This field supports communication management and HR coordination.
HomeWorkLocationCommunicationFaxes	String	True		The fax contact information for the worker's home work location. This field supports HR correspondence, document transmission, and site-level communication records.
HomeWorkLocationCommunicationLandlines	String	True		The landline telephone numbers that are associated with the home work location. This field supports HR contact directories, facility communication, and emergency planning.
HomeWorkLocationCommunicationMobiles	String	True		The mobile telephone numbers that are associated with the home work location. This field supports HR facility communication, on-call coordination, and safety contact requirements.
HomeWorkLocationCommunicationPagers	String	True		The pager contact numbers that are associated with the home work location. This field supports HR emergency notification systems and field response coordination.
HomeWorkLocationNameCodeValue	String	False		The code that identifies the name or label for the home work location (for example, Main Office, Regional Hub, or Distribution Center). This field supports HR location management and payroll cost allocation.
HomeWorkLocationNameCodeLongName	String	True		The full descriptive name of the home work location code. This field provides context for HR reporting, payroll records, and organizational mapping.
HomeWorkLocationNameCodeShortName	String	False		The abbreviated name that corresponds to the home work location code. This field supports compact reporting and HR data exports.
IndustryClassifications	String	False		The industry classification codes that are linked to the worker's assignment. This field supports HR reporting, compliance tracking, and regulatory classification (for example, NAICS or SIC).
JobCodeValue	String	False		The code that identifies the job classification assigned to the worker. This field supports HR job framework management and payroll configuration.
JobCodeEffectiveDate	Date	True		The date that defines when the current job code became effective. This field supports HR job history tracking and compensation alignment.
JobCodeLongName	String	True		The full descriptive name of the job code assigned to the worker. This field provides context for HR reports, job descriptions, and payroll documentation.
JobCodeShortName	String	False		The abbreviated name that corresponds to the job code. This field supports compact data presentation in HR dashboards and internal reports.
JobTitle	String	True		The title associated with the worker's current job. This field supports HR personnel records, payroll alignment, and organization chart display.
LaborUnionLaborUnionCodeValue	String	False		The code that identifies the labor union to which the worker belongs. This field supports HR compliance with collective bargaining agreements and labor law tracking.
LaborUnionLaborUnionCodeLongName	String	True		The full descriptive name of the labor union code. This field provides clarity in HR labor relations reporting and payroll processing.
LaborUnionLaborUnionCodeShortName	String	False		The abbreviated name that corresponds to the labor union code. This field supports concise labeling in HR dashboards and collective agreement summaries.
LaborUnionSeniorityDate	Date	True		The date that defines when the worker's labor union seniority began. This field supports HR union eligibility, benefits tracking, and seniority-based calculations.
LegalEntityID	String	True		The unique identifier (Id) that represents the legal entity associated with the worker's assignment. This field supports HR corporate structure management, payroll segregation, and compliance reporting.
Links	String	True		The links that connect this record to related resources, such as other HR records, payroll files, or assignment data. This field supports data navigation and API integration.
ManagementPositionIndicator	Boolean	False		A Boolean value that indicates whether the worker holds a management position. This field supports HR leadership classification, payroll approvals, and organizational reporting.
MinimumPayGradeStepDuration	String	True		The minimum duration that a worker must remain in the current pay grade step before becoming eligible for advancement. This field supports HR compensation policies and pay progression tracking.
NationalityContextCodeValue	String	True		The code that identifies the nationality or citizenship context associated with the worker's assignment. This field supports HR compliance and global workforce reporting.
NationalityContextCodeLongName	String	True		The full descriptive name of the nationality context code. This field provides clarity in HR documentation, especially for international assignment tracking.
NationalityContextCodeShortName	String	True		The abbreviated name that corresponds to the nationality context code. This field supports compact data display in HR dashboards and compliance exports.
NextPayGradeStepDate	Date	True		The date that defines when the worker is scheduled to move to the next pay grade step. This field supports HR compensation management and career progression planning.
OccupationalClassifications	String	False		The occupational classification codes that describe the worker's role or profession (for example, SOC or ISCO codes). This field supports HR job categorization, compliance, and government reporting.
OfferAcceptanceDate	Date	True		The date that defines when the worker accepted the employment offer. This field supports HR recruitment tracking, onboarding scheduling, and legal documentation.
OfferExtensionDate	Date	True		The date that defines when the employment offer was extended to the worker. This field supports HR recruitment timelines and compliance documentation.
OfficerIndicator	Boolean	True		A Boolean value that indicates whether the worker holds an officer designation within the organization. This field supports HR governance, executive classification, and payroll reporting.
OfficerTypeCodeValue	String	False		The code that identifies the officer classification type (for example, Corporate Officer, Financial Officer, or Legal Officer). This field supports HR hierarchy tracking and compliance reporting.
OfficerTypeCodeLongName	String	True		The full descriptive name of the type code for the officer. This field provides the detailed label used in HR documentation and payroll systems.
OfficerTypeCodeShortName	String	False		The abbreviated name that corresponds to the type code for the officer. This field supports compact labeling in HR dashboards and compliance exports.
PayCycleCodeValue	String	False		The code that identifies the pay cycle associated with the worker's assignment (for example, Weekly, Biweekly, or Monthly). This field supports HR payroll frequency configuration and wage calculation.
PayCycleCodeLongName	String	True		The full descriptive name of the pay cycle code. This field provides clarity in HR and payroll documentation.
PayCycleCodeShortName	String	False		The abbreviated name that corresponds to the pay cycle code. This field supports compact reporting and payroll system display.
PayGradeCodeValue	String	False		The code that identifies the pay grade assigned to the worker's job classification. This field supports HR compensation framework mapping and payroll validation.
PayGradeCodeLongName	String	True		The full descriptive name of the pay grade code. This field provides a complete label used in HR compensation reporting and documentation.
PayGradeCodeShortName	String	False		The abbreviated name that corresponds to the pay grade code. This field supports compact display in HR dashboards and exports.
PayGradePayRangeMaximumRateAmountValue	Decimal	True		The maximum pay rate amount defined for the worker's pay grade range. This field supports HR compensation modeling and payroll validation.
PayGradePayRangeMaximumRateBaseMultiplierValue	Integer	True		The numeric multiplier that represents the base unit factor applied to calculate the maximum pay rate. This field supports HR pay scale calculations and payroll computation.
PayGradePayRangeMaximumRateBaseUnitCodeValue	String	True		The code that identifies the base unit used for calculating the maximum pay rate (for example, Hour, Month, or Year). This field supports HR rate standardization and payroll consistency.
PayGradePayRangeMaximumRateBaseUnitCodeLongName	String	True		The full descriptive name of the base unit code used in the maximum pay rate calculation. This field provides clarity in HR documentation and compensation reports.
PayGradePayRangeMaximumRateBaseUnitCodeShortName	String	True		The abbreviated name that corresponds to the base unit code for the maximum pay rate. This field supports compact display in HR dashboards and payroll exports.
PayGradePayRangeMaximumRateCurrencyCode	String	True		The currency code that defines the denomination of the maximum pay rate (for example, USD, CAD, or GBP). This field supports HR international payroll reporting and consistency.
PayGradePayRangeMaximumRateUnitCodeValue	String	True		The code that identifies the pay unit used for expressing the maximum pay rate (for example, Hourly, Monthly, or Annual). This field supports HR compensation structure alignment.
PayGradePayRangeMaximumRateUnitCodeLongName	String	True		The full descriptive name of the pay unit code associated with the maximum pay rate. This field provides context for HR and payroll documentation.
PayGradePayRangeMaximumRateUnitCodeShortName	String	True		The abbreviated name that corresponds to the pay unit code for the maximum pay rate. This field supports compact HR data presentation and reporting.
PayGradePayRangeMedianRateAmountValue	Decimal	True		The monetary amount that represents the median rate within the worker's pay grade range. This field supports HR pay structure benchmarking and compensation analytics.
PayGradePayRangeMedianRateBaseMultiplierValue	Integer	True		The numeric multiplier that represents the base unit factor applied to calculate the median pay rate. This field supports HR and payroll pay grade consistency.
PayGradePayRangeMedianRateBaseUnitCodeValue	String	True		The code that identifies the base unit used for the median pay rate calculation (for example, Hour, Month, or Year). This field supports HR and payroll data standardization.
PayGradePayRangeMedianRateBaseUnitCodeLongName	String	True		The full descriptive name of the base unit used in the median pay rate calculation. This field provides detailed context for HR reporting and payroll computation.
PayGradePayRangeMedianRateBaseUnitCodeShortName	String	True		The abbreviated name that corresponds to the base unit code for the median pay rate calculation. This field supports compact HR data display and payroll system exports.
PayGradePayRangeMedianRateCcurrencyCode	String	True		The currency code that defines the denomination of the median pay rate (for example, USD, CAD, or GBP). This field supports HR compensation benchmarking and payroll consistency across regions.
PayGradePayRangeMedianRateUnitCodeValue	String	True		The code that identifies the pay unit used to express the median rate within the pay grade (for example, Hourly, Monthly, or Annual). This field supports HR pay structure reporting and payroll classification.
PayGradePayRangeMedianRateUnitCodeLongName	String	True		The full descriptive name of the pay unit code used for the median rate. This field provides clarity in HR documentation and pay structure configuration.
PayGradePayRangeMedianRateUnitCodeShortName	String	True		The abbreviated name that corresponds to the pay unit code for the median rate. This field supports compact HR display in dashboards and data exports.
PayGradePayRangeMinimumRateAmountValue	Decimal	True		The monetary amount that represents the minimum rate within the worker's pay grade range. This field supports HR pay scale management and payroll compliance.
PayGradePayRangeMinimumRateBaseMultiplierValue	Integer	True		The numeric multiplier that represents the base unit factor applied to calculate the minimum pay rate. This field supports HR pay grade alignment and compensation analytics.
PayGradePayRangeMinimumRateBaseUnitCodeValue	String	True		The code that identifies the base unit used for calculating the minimum pay rate (for example, Hour, Month, or Year). This field supports HR rate standardization and payroll consistency.
PayGradePayRangeMinimumRateBaseUnitCodeLongName	String	True		The full descriptive name of the base unit used to determine the minimum pay rate. This field provides detailed context for HR reporting and payroll computation.
PayGradePayRangeMinimumRateBaseUnitCodeShortName	String	True		The abbreviated name that corresponds to the base unit code for the minimum pay rate. This field supports compact display in HR dashboards and payroll reports.
PayGradePayRangeMinimumRateCurrencyCode	String	True		The currency code that defines the denomination of the minimum pay rate (for example, USD, GBP, or EUR). This field supports HR international payroll reporting and consistency.
PayGradePayRangeMinimumRateUnitCodeValue	String	True		The code that identifies the pay unit used to express the minimum rate within the pay grade (for example, Hourly, Weekly, or Annual). This field supports HR compensation management and payroll configuration.
PayGradePayRangeMinimumRateUnitCodeLongName	String	True		The full descriptive name of the pay unit code associated with the minimum pay rate. This field provides clarity for HR documentation and pay scale reporting.
PayGradePayRangeMinimumRateUnitCodeShortName	String	True		The abbreviated name that corresponds to the pay unit code for the minimum pay rate. This field supports concise HR display and payroll system integration.
PayGradeStepCodeValue	String	True		The code that identifies the pay grade step within the worker's assigned grade. This field supports HR compensation step progression and payroll calculation accuracy.
PayGradeStepCodeLongName	String	True		The full descriptive name of the pay grade step code. This field provides context for HR documentation, pay structure reports, and employee compensation history.
PayGradeStepCodeShortName	String	True		The abbreviated name that corresponds to the pay grade step code. This field supports compact HR data display in dashboards and compensation tables.
PayGradeStepPayRateAmountValue	Decimal	True		The monetary amount that represents the pay rate associated with the worker's current pay grade step. This field supports HR compensation calculations and payroll recordkeeping.
PayGradeStepPayRateBaseMultiplierValue	Integer	True		The numeric multiplier that represents the base unit factor applied to calculate the step pay rate. This field supports HR compensation modeling and payroll validation.
PayGradeStepPayRateBaseUnitCodeValue	String	True		The code that identifies the base unit used for calculating the pay grade step rate (for example, Hour, Month, or Year). This field supports HR rate standardization and payroll consistency.
PayGradeStepPayRateBaseUnitCodeLongName	String	True		The full descriptive name of the base unit code for the step pay rate. This field provides HR clarity in documentation and reporting.
PayGradeStepPayRateBaseUnitCodeShortName	String	True		The abbreviated name that corresponds to the base unit code for the step pay rate. This field supports compact HR dashboard display and payroll integration.
PayGradeStepPayRateCurrencyCode	String	True		The currency code that defines the denomination of the pay grade step rate (for example, USD, CAD, or GBP). This field supports HR international payroll consistency and wage accuracy.
PayGradeStepPayRateUnitCodeValue	String	True		The code that identifies the pay unit used to express the pay grade step rate (for example, Hourly, Weekly, or Annual). This field supports HR payroll configuration and compensation alignment.
PayGradeStepPayRateUnitCodeLongName	String	True		The full descriptive name of the pay unit code associated with the pay grade step rate. This field provides context for HR reporting and payroll documentation.
PayGradeStepPayRateUnitCodeShortName	String	True		The abbreviated name that corresponds to the pay unit code for the pay grade step rate. This field supports concise HR dashboard display and reporting consistency.
PayrollFileNumber	String	False		The number that identifies the worker's payroll file. This field supports HR payroll administration, employee record tracking, and compliance audits.
PayrollGroupCode	String	False		The code that identifies the payroll group to which the worker belongs. This field supports HR payroll configuration, batch processing, and reporting segmentation.
PayrollProcessingStatusCodeValue	String	True		The code that identifies the current payroll processing status (for example, Pending, Processed, or Approved). This field supports HR payroll workflow tracking and system integration.
PayrollProcessingStatusCodeEffectiveDate	Date	True		The date that defines when the current payroll processing status became effective. This field supports HR audit tracking and payroll cycle management.
PayrollProcessingStatusCodeLongName	String	True		The full descriptive name of the payroll processing status code. This field provides clarity in HR documentation and payroll system reports.
PayrollProcessingStatusCodeShortName	String	True		The abbreviated name that corresponds to the payroll processing status code. This field supports compact HR dashboard reporting.
PayrollRegionCode	String	True		The code that identifies the payroll region responsible for processing the worker's pay. This field supports HR jurisdiction management, tax configuration, and multi-region payroll alignment.
PayrollScheduleGroupID	String	True		The unique identifier (Id) that represents the payroll schedule group to which the worker's pay is assigned. This field supports HR pay cycle configuration and payroll scheduling.
PayScaleCodeValue	String	True		The code that identifies the pay scale or salary structure associated with the worker's assignment. This field supports HR compensation framework mapping and payroll alignment.
PayScaleCodeLongName	String	True		The full descriptive name of the pay scale code that defines the salary structure assigned to the worker. This field supports HR compensation planning, payroll configuration, and job structure alignment.
PayScaleCodeShortName	String	True		The abbreviated name that corresponds to the pay scale code. This field supports compact HR reporting and payroll dashboard display.
PositionID	String	False		The unique identifier (Id) that represents the position associated with the worker's assignment. This field supports HR job tracking, organizational hierarchy mapping, and payroll reporting.
PositionTitle	String	True		The title of the position associated with the worker's current assignment. This field supports HR organization chart display and job classification.
PrimaryIndicator	Boolean	True		A Boolean value that indicates whether this is the worker's primary work assignment. This field supports HR reporting, benefits eligibility, and payroll calculations.
RemunerationBasisCodeValue	String	True		The code that identifies the basis on which the worker's remuneration is calculated (for example, salary, hourly, or commission). This field supports HR compensation configuration and payroll alignment.
RemunerationBasisCodeLongName	String	True		The full descriptive name of the remuneration basis code. This field provides clarity for HR documentation and payroll setup.
RemunerationBasisCodeShortName	String	True		The abbreviated name that corresponds to the remuneration basis code. This field supports compact HR and payroll reporting.
ReportsTo	String	False		The unique identifier (Id) or reference that specifies the person or position to whom the worker reports. This field supports HR management hierarchy and performance reporting.
SeniorityDate	Date	True		The date that defines when the worker's continuous service began. This field supports HR tenure calculations, benefits eligibility, and labor law compliance.
StandardHoursQuantity	Integer	False		The number of standard work hours assigned to the worker per unit period. This field supports HR scheduling, payroll calculation, and time reporting.
StandardHoursUnitCodeValue	String	True		The code that identifies the time unit associated with the standard work hours (for example, hour, week, or month). This field supports HR time-tracking alignment and payroll configuration.
StandardHoursUnitCodeLongName	String	True		The full descriptive name of the time unit associated with the standard work hours. This field provides context in HR documentation and scheduling reports.
StandardHoursUnitCodeShortName	String	True		The abbreviated name that corresponds to the time unit for standard hours. This field supports compact HR and payroll data display.
StandardPayPeriodHoursHoursQuantity	Integer	True		The number of hours that defines the standard duration of a pay period for the worker. This field supports HR payroll planning and wage rate computation.
StandardPayPeriodHoursUnitCodeValue	String	True		The code that identifies the time unit used for defining the standard pay period hours (for example, hour, day, or week). This field supports HR payroll configuration.
StandardPayPeriodHoursUnitCodeLongName	String	True		The full descriptive name of the time unit associated with the standard pay period hours. This field provides clarity in HR documentation and payroll scheduling.
StandardPayPeriodHoursUnitCodeShortName	String	True		The abbreviated name that corresponds to the time unit for standard pay period hours. This field supports concise HR data presentation and payroll reporting.
StockOwnerIndicator	Boolean	True		A Boolean value that indicates whether the worker holds stock in the company. This field supports HR executive tracking, compensation disclosure, and compliance documentation.
StockOwnerPercentage	Integer	True		The percentage that represents the portion of company stock owned by the worker. This field supports HR compensation reporting, equity management, and compliance tracking.
TerminationDate	Date	False		The date that defines when the worker's employment or assignment ended. This field supports HR offboarding, payroll closure, and compliance reporting.
VipIndicator	Boolean	True		A Boolean value that indicates whether the worker holds VIP status within the organization. This field supports HR executive management, payroll exception handling, and system access control.
VipTypeCodeValue	String	True		The code that identifies the classification of the worker's VIP type (for example, executive, Partner, or Advisor). This field supports HR visibility configuration and payroll categorization.
VipTypeCodeLongName	String	True		The full descriptive name of the type code for the VIP. This field provides detailed context for HR executive tracking and payroll configuration.
VipTypeCodeShortName	String	True		The abbreviated name that corresponds to the type code for the VIP. This field supports compact HR and payroll reporting.
WageLawCoverageCodeValue	String	False	WageLawCoverageCode.CodeValue	The code that identifies the wage law coverage applicable to the worker (for example, FLSA Exempt, Non-Exempt, or Union). This field supports HR compliance and labor law reporting.
WageLawCoverageCodeLongName	String	True		The full descriptive name of the wage law coverage code. This field provides clarity in HR compliance documentation and payroll systems.
WageLawCoverageCodeShortName	String	False		The abbreviated name that corresponds to the wage law coverage code. This field supports concise HR compliance reporting.
WageLawCoverageWageLawNameCodeValue	String	True		The code that identifies the specific wage law that applies to the worker's assignment (for example, FLSA or State Overtime Law). This field supports HR regulatory alignment and payroll compliance.
WageLawCoverageWageLawNameCodeLongName	String	True		The full descriptive name of the wage law name code. This field provides clarity in HR and compliance documentation.
WageLawCoverageWageLawNameCodeShortName	String	True		The abbreviated name that corresponds to the wage law name code. This field supports compact HR compliance reporting and audit exports.
WorkArrangementCodeValue	String	True		The code that identifies the work arrangement type assigned to the worker (for example, On-site, Hybrid, or Remote). This field supports HR workforce management and payroll configuration.
WorkArrangementCodeLongName	String	True		The full descriptive name of the work arrangement code. This field provides detailed context for HR scheduling and location-based compliance.
WorkArrangementCodeShortName	String	True		The abbreviated name that corresponds to the work arrangement code. This field supports compact HR reporting and data exports.
WorkerGroups	String	True		The worker group codes that identify the collective or classification group to which the worker belongs. This field supports HR grouping, reporting, and payroll segmentation.
WorkerProbationIndicator	Boolean	True		A Boolean value that indicates whether the worker is currently in a probationary period. This field supports HR onboarding tracking and eligibility management.
WorkerProbationPeriodEndDate	Date	True		The date that defines when the worker's probationary period ends. This field supports HR monitoring of employee status changes and benefits eligibility.
WorkerProbationPeriodStartDate	Date	True		The date that defines when the worker's probationary period begins. This field supports HR onboarding and probation tracking.
WorkerTypeCodeValue	String	False	WorkerTypeCode.CodeValue	The code that identifies the type of worker (for example, Employee, Contractor, or Temporary). This field supports HR classification and payroll compliance.
WorkerTypeCodeLongName	String	True		The full descriptive name of the type code for the worker. This field provides context for HR documentation and employment classification reporting.
WorkerTypeCodeShortName	String	True		The abbreviated name that corresponds to the type code for the worker. This field supports compact HR data display and reporting.
WorkLevelCodeValue	String	True		The code that identifies the worker's job or responsibility level (for example, Entry, Mid, or Senior). This field supports HR job framework alignment and payroll scaling.
WorkLevelCodeLongName	String	True		The full descriptive name of the work-level code. This field provides clarity for HR reporting and job classification documentation.
WorkLevelCodeShortName	String	True		The abbreviated name that corresponds to the work-level code. This field supports compact HR reporting and analytics.
WorkShiftCodeValue	String	True		The code that identifies the worker's assigned work shift (for example, Day, Night, or Rotating). This field supports HR scheduling and payroll calculation.
WorkShiftCodeLongName	String	True		The full descriptive name of the work shift code. This field provides detailed context for HR shift planning and payroll alignment.
WorkShiftCodeShortName	String	True		The abbreviated name that corresponds to the work shift code. This field supports concise HR display and reporting.
JobFunctionCodeValue	String	True		The code that identifies the job function associated with the worker's position (for example, Finance, Engineering, or Operations). This field supports HR organizational mapping and payroll classification.
JobFunctionCodeShortName	String	True		The abbreviated name that corresponds to the job function code. This field supports compact HR data representation and reporting.
JobFunctionCodeLongName	String	True		The full descriptive name of the job function code. This field provides clarity for HR reporting and job classification documentation.
AsOfDate	Date	True		The date that defines when the data in this record is effective. This field supports HR reporting, payroll timing, and data version tracking.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
EffectiveDate	Date	The date that is used to update the position identifier (Id) and assigned organizational units. This field supports HR record updates and payroll synchronization.
LastWorkedDate	Date	The date that defines when the worker last performed work. This field supports HR termination tracking, payroll finalization, and benefits eligibility.
RehireEligibleIndicator	Boolean	A Boolean value that indicates whether the worker is eligible for rehire. This field supports HR post-termination evaluations and workforce planning.
SeveranceEligibleIndicator	Boolean	A Boolean value that indicates whether the worker qualifies for severance pay. This field supports HR offboarding management and payroll processing.
TerminationComments	String	The comments that describe the reason or context for the worker's termination. This field supports HR documentation and compliance reporting.
BaseRemunerationCode	String	The code that identifies the remuneration structure associated with the worker's assignment. This field supports HR compensation modeling and payroll alignment.
EventReasonCode	String	The code that identifies the reason associated with the HR event that triggered this update (for example, Promotion, Transfer, or Termination). This field supports HR audit tracking and system automation.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Python Connector for ADP Views


Name	Description
AdditionalRemunerationNameCode	The view that provides reference data for additional remuneration name codes. This view defines supplemental pay elements (for example, bonuses, commissions, or incentive payments) that are recognized in ADP payroll processing. This view is used to standardize remuneration types across payroll reports and calculations.
AssociatePaymentsAllocationsEarningsAndBenefits	The view that presents detailed information about how each associate's earnings and benefits are allocated in payroll outputs. This view enables reconciliation of earnings categories with corresponding benefit components to ensure accurate financial reporting.
AssociatePaymentsAllocationsEarningSections	The view that displays the earning section breakdowns for associate payment allocations. This view organizes payroll results by section (for example, regular pay, overtime, and adjustments) to support payroll review and compliance validation.
AssociatePaymentsAllocationsNonStatutoryDeductions	The view that returns non-statutory deduction details for associate payment allocations in payroll outputs. This view includes deductions that are not legally mandated, such as employee-elected benefits, charitable contributions, or loan repayments.
AssociatePaymentsAllocationsStatutoryDeductions	The view that displays statutory deduction information for associate payment allocations in payroll outputs. This view includes deductions that are required by law, such as income taxes, social security contributions, and other government withholdings.
AssociatePaymentsSummaryEarningsAndBenefits	The view that summarizes all earnings and benefits for each associate within a payroll output. This view provides a high-level snapshot for auditing and financial reconciliation of payroll data.
AssociatePaymentsSummaryEarningsSections	The view that aggregates earnings by section (for example, regular earnings, overtime, or bonuses) for each associate in payroll outputs. This view provides structured data for compliance and reporting purposes.
AssociatePaymentsSummaryNonStatutoryDeductions	The view that summarizes non-statutory deductions for each associate in payroll outputs. This view allows payroll teams to verify optional deductions that are applied according to employee elections or company policies.
AssociatePaymentsSummaryPayrollAccumulations	The view that provides cumulative payroll totals for each associate, including accumulated earnings, deductions, and benefits. This view supports audit trail validation and long-term payroll analytics.
AssociatePaymentsSummaryStatutoryDeductions	The view that summarizes all statutory deductions (for example, tax withholdings and mandated contributions) for each associate in payroll outputs. This view is used for compliance reporting and reconciliation with government filings.
BenefitCoverages	benefit coverages information for an employee.
CostCenters	The view that returns the cost center codes configured for the client in ADP. This view enables payroll expense tracking and departmental allocation of labor costs for internal reporting and financial analysis.
DeductionInputCode	The view that provides reference data for deduction input codes. This view defines each deduction type that is supported in payroll calculations, ensuring standardized mapping across payroll configurations.
EarningInputCode	The view that provides reference data for earning input codes. This view lists earning categories that are used to classify income types such as salary, overtime, or commission in payroll processing.
GenerationAffixCode	The view that returns standardized legal name affix codes (for example, Jr., Sr., or III). This view ensures consistent associate identity representation across Human Resources (HR) and payroll systems.
HighestEducationLevelCode	The view that returns standardized education level codes for associates. This view supports Human Resources (HR) analytics, diversity reporting, and compliance documentation that rely on education data.
JobApplications	The view that returns job-application records that are captured through the ADP recruiting module. It provides applicant data that is used for candidate tracking, evaluation, and onboarding workflows.
JobApplicationsCommunicationLandlines	The view that returns candidate landline phone numbers that are associated with job applications. It supports communication record management for recruiting and compliance reporting.
JobApplicationsCommunicationMobiles	The view that returns candidate mobile contact numbers that are linked to job applications. It provides mobile communication details for recruitment correspondence and tracking.
jobRequisitions	The view that returns job requisition data for open or closed positions. It supports hiring pipeline management and alignment of workforce planning with organizational goals.
JobRequisitionsOrganizationalUnits	The view that returns organizational unit details that are associated with each job requisition. It enables mapping between requisitions and the company's hierarchical structure for planning and reporting.
MaritalStatusCode	The view that provides standardized marital status codes that are used in associate profiles. It supports HR data accuracy and payroll tax configuration based on filing status.
OnboardingTemplate	The view that returns onboarding templates that are configured in ADP. Each template defines workflow steps, documentation requirements, and tasks that are applied to new-hire onboarding processes.
PaidTimeOffBalances	The view that returns current paid time-off (PTO) balances for associates. It is used to track available leave accruals, support scheduling, and ensure compliance with company PTO policies.
PaidTimeOffRequestEntries	The view that returns associate paid time-off (PTO) requests, including dates, hours, and request statuses. It supports HR workflows that manage approvals, scheduling, and payroll synchronization.
PaidTimeOffRequests	The view that returns detailed records of paid time-off (PTO) requests that are submitted by associates. It includes information such as request dates, hours, reasons, and approval statuses. This view is used to track leave management and synchronize approved requests with payroll and scheduling systems.
PayrollGroup	The view that returns payroll-group information that is configured in ADP. A payroll group defines a collection of workers that share the same payroll cycle, frequency, and processing rules. This view supports payroll scheduling, grouping, and administrative reporting.
PayrollMemos	The view that returns payroll memo entries that are used to record messages, notes, or instructions that are related to payroll processing. Payroll administrators use these memos to document special adjustments, approvals, or compliance notes for each pay run.
PersonalContacts	The view that returns personal and emergency contact information for each associate. This view includes contact names, relationships, and communication details. This view supports compliance with workplace safety and Human Resources (HR) record-keeping requirements.
QualificationAffixCode	The view that provides standardized codes for worker-qualification affixes. This view defines credential suffixes and related classification codes that are applied to worker records to indicate certifications, degrees, or titles.
ReimbursementInputCode	The view that provides reference data for reimbursement input codes. This view lists reimbursement types (for example, travel, mileage, or expenses) that are used in payroll processing. The view enables standardized mapping of reimbursement categories.
TeamTimeCards	The view that returns time card data for all workers in a specific team. This view includes time entries, attendance records, and worked hours. This view supports team-level scheduling, payroll validation, and labor reporting.
TeamTimeCardsAllTeams	The view that returns time card data for all teams within the organization. This view consolidates multiple team records into a single dataset for workforce management and payroll reconciliation.
TeamTimeCardsDailyTotals	The view that returns aggregated daily totals from team time cards. This view summarizes the total hours that are worked by team and day, enabling supervisors to monitor attendance patterns and manage overtime compliance.
TeamTimeCardsDayEntries	The view that returns daily time card entries for each worker, along with associated totals. This view provides a day-by-day breakdown of team activity that is used to verify attendance, validate time entries, and approve hours for payroll.
TeamTimeCardsHomeLaborAllocations	The view that returns home-labor allocation data for team time cards. This view identifies how hours worked are distributed across home cost centers, locations, or projects. This view supports labor allocation and cost accounting.
TeamTimeCardsPeriodTotals	The view that returns aggregated period totals from team time cards. This view summarizes total hours, regular pay, and overtime over a complete payroll period. This data supports payroll calculation and compliance with labor regulations.
TimeCards	The view that returns time card data for individual workers. This view includes daily and period totals, job codes, and pay types. This view supports time tracking, payroll preparation, and compliance with attendance policies.
TimeCardsAllActiveWorkers	The view that returns time card data for all active workers in the organization. It consolidates current worker time records to provide a comprehensive overview of attendance and worked hours across departments.
TimeCardsDailyTotals	The view that returns daily time card totals for individual workers. This view summarizes hours worked each day by category (for example, Regular, Overtime, or Leave) to support payroll review and reporting.
TimeCardsPeriodTotals	The view that returns total hours and earnings that are aggregated over an entire payroll period for each worker. This view provides summarized data that is used for payroll calculation and compliance tracking.
WageLawCoverageCode	The view that returns standardized wage-law coverage codes that are applied to worker records. This view identifies the regulatory wage-coverage classification for each position or location, supporting compliance with local and federal labor laws.
WorkAssignmentCustomHistoryCustomGroupAmountFields	The view that returns historical data for custom amount fields that are defined within work-assignment custom groups. This view tracks numeric compensation or allocation values that are associated with each work assignment.
WorkAssignmentCustomHistoryCustomGroupCodeFields	The view that returns historical data for code-based fields defined in work-assignment custom groups. This view includes classification or lookup values that are used to categorize historical work-assignment information.
WorkAssignmentCustomHistoryCustomGroupDateFields	The view that returns historical data for date fields that are defined within work-assignment custom groups. This view is used to track important milestone or effective dates for assignment changes and employment events.
WorkAssignmentCustomHistoryCustomGroupDateTimeFields	The view that returns historical data for date-time fields that are defined in work-assignment custom groups. This view captures both date and timestamp information for work-assignment changes and related Human Resources (HR) events.
WorkAssignmentCustomHistoryCustomGroupIndicatorFields	The view that returns historical data for indicator fields within work-assignment custom groups. This view stores Boolean or flag-based information that identifies specific employment conditions or attributes.
WorkAssignmentCustomHistoryCustomGroupLinks	The view that returns link field data for work-assignment custom groups. This view maintains relationships between custom fields and other reference entities, allowing traceability of historical assignment data.
WorkAssignmentCustomHistoryCustomGroupNumberFields	The view that returns historical data for numeric fields that are defined within work-assignment custom groups. This view tracks quantitative metrics (for example, hours, rates, or counts) that are related to historical work assignments.
WorkAssignmentCustomHistoryCustomGroupPercentFields	The view that returns historical data for percent fields that are defined within work-assignment custom groups. This view captures percentage-based metrics such as allocation ratios or contribution percentages that are tied to historical assignments.
WorkAssignmentCustomHistoryCustomGroupStringFields	The view that returns historical data for text-based fields that are defined within work-assignment custom groups. This view captures descriptive or narrative information stored in historical records.
WorkAssignmentCustomHistoryCustomGroupTelephoneFields	The view that returns historical data for telephone fields that are defined within work-assignment custom groups. This view captures contact numbers or communication Ids that are linked to historical assignments.
WorkAssignmentHistory	The view that returns the full historical record of work assignments for each associate. It tracks changes in position, department, or reporting structure over time. This view supports compliance, analytics, and employment verification.
WorkAssignmentHistoryAdditionalRemunerations	The view that returns historical records of additional remunerations that are associated with work assignments. This view captures supplemental earnings (for example, bonuses or allowances) that are applied to past payroll periods for auditing and reconciliation.
WorkAssignmentHistoryAssignedOrganizationalUnits	The view that returns the historical record of organizational units that are assigned to each work assignment. This view tracks how an associate's reporting structure and departmental affiliations have changed over time. This data supports organizational audits and workforce mobility analysis.
WorkAssignmentHistoryAssignedWorkLocations	The view that returns the historical record of work locations that are assigned to each associate's work assignment. This view captures location transfers, remote-work changes, and other location-based adjustments that are relevant for payroll taxation and compliance tracking.
WorkAssignmentHistoryCommunicationsEmails	The view that returns historical email communication details that are associated with work assignments. This view maintains a record of email addresses used by workers over time for internal correspondence and audit verification.
WorkAssignmentHistoryCommunicationsFaxes	The view that returns historical fax communication records for work assignments. This view preserves legacy fax contact data that is associated with employee assignments for historical or compliance purposes.
WorkAssignmentHistoryCommunicationsInstantMessages	The view that returns historical instant-messaging contact data that is linked to work assignments. This view supports audit and compliance reviews of internal communication methods over time.
WorkAssignmentHistoryCommunicationsInternetAddresses	The view that returns historical records of internet addresses that area associated with work assignments. This view includes data (for example, employee website or network Ids) that are tracked for security and compliance.
WorkAssignmentHistoryCommunicationsLandlines	The view that returns historical landline communication details that are associated with work assignments. This view records telephone contact numbers that were active during prior assignment periods for reference and compliance reporting.
WorkAssignmentHistoryCommunicationsMobiles	The view that returns historical mobile-phone contact data for each work assignment. This view tracks changes in mobile communication channels used by associates for accessibility and Human Resources (HR) audit purposes.
WorkAssignmentHistoryCommunicationsPagers	The view that returns historical pager contact data that is associated with work assignments. This view supports legacy communication recordkeeping and historical audit reviews.
WorkAssignmentHistoryCommunicationsSocialNetworks	The view that returns historical social-network contact information that is linked to work assignments. This view captures professional network Ids used in Human Resources (HR) systems for profile completeness and compliance documentation.
WorkAssignmentHistoryHomeOrganizationalUnits	The view that returns the historical record of home organizational units for each associate's work assignment. This view identifies an employee's primary business unit over time for historical analysis and payroll allocation.
WorkAssignmentHistoryIndustryClassifications	The view that returns historical industry classification codes that are associated with work assignments. This view tracks the classification of roles or departments according to industry-standard codes that are used for compliance and reporting.
WorkAssignmentHistoryOccupationalClassifications	The view that returns historical occupational classification codes for work assignments. This view maintains standardized occupation data for regulatory reporting and labor statistics tracking.
WorkAssignmentHistoryReport	The view that compiles a comprehensive report of historical work-assignment records. This view integrates multiple dimensions (for example, organizational units, locations, and communication fields) into a unified dataset for compliance and workforce analysis.
WorkAssignmentHistoryWorkerGroups	The view that returns historical records of worker-group assignments. This view tracks group memberships (for example, departments or teams) that are associated with work assignments across time for analytical and compliance purposes.
WorkerDemographics	The view that returns demographic information for each worker in the organization. This view includes attributes such as age range, gender, ethnicity, and marital status. This view supports diversity analytics, workforce planning, and compliance reporting.
WorkersBusinessCommunicationEmails	The view that returns business-email contact information for workers. This view includes primary and secondary email addresses that are used for company communication and identity verification.
WorkersBusinessCommunicationFaxes	The view that returns business fax numbers that are associated with worker profiles. This view maintains legacy fax-communication data for administrative and compliance use.
WorkersBusinessCommunicationLandlines	The view that returns business landline contact information for workers. This view lists office phone extensions and mainline numbers for Human Resources (HR) and directory reporting.
WorkersBusinessCommunicationMobiles	The view that returns business mobile-phone contact data for workers. This view captures mobile numbers that are linked to corporate communication systems and used for workforce contact management.
WorkersBusinessCommunicationPagers	The view that returns business-pager contact data for workers. This view preserves historical or legacy pager records that are used for on-call or field communication tracking.
WorkersLeaves	Leaves for an employee.
WorkersPersonBirthNamePreferredSalutations	The view that returns preferred salutation information that is associated with each worker's birth name. This view standardizes greeting formats (for example, Mr., Ms., or Dr.), which are used in formal Human Resources (HR) and correspondence records.
WorkersPersonBirthNameTitleAffixCodes	The view that returns title affix codes for worker birth names (for example, Jr., Sr., or III). This view ensures legal name accuracy and consistent representation of personal Ids across Human Resources (HR) and payroll systems.
WorkersPersonBirthNameTitlePrefixCodes	The view that returns title prefix codes for worker birth names (for example, Mr., Mrs., or Dr). This view provides standardized title data that is used in employee identification and official reporting.
WorkersPersonGovernmentIDs	The view that returns government identification data for each worker. This view includes identifiers such as Social Security Numbers, Tax Ids, or national identification codes. It supports verification, payroll compliance, and reporting to government agencies.
WorkersPersonLegalNamePreferredSalutations	The view that returns preferred salutations that are associated with each worker's legal name. This view standardizes how names are displayed in Human Resources (HR) documents, correspondence, and system-generated communications.
WorkersPersonLegalNameTitleAffixCodes	The view that returns title affix codes associated with each worker's legal name (for example, Jr., Sr., or III). This view ensures consistent use of legal name suffixes across Human Resources (HR) and payroll records.
WorkersPersonLegalNameTitlePrefixCodes	The view that returns title prefix codes that are associated with each worker's legal name (for example, Mr., Mrs., or Dr). This view supports proper formatting of names in official Human Resources (HR) and payroll documentation.
WorkersPersonMilitaryClassificationCodes	The view that returns military classification codes for workers who have served or are serving in the military. This view supports compliance reporting and veteran status tracking for workforce diversity and government reporting.
WorkersPhotoLinks	The view that returns hyperlink references to worker photos that are stored within ADP systems. This view allows applications and reports to reference image assets without embedding the image data directly.
WorkersPhotos	The view that returns worker photos that are stored in ADP. This view provides image data that is associated with worker profiles for use in identification, security systems, and Human Resources (HR) applications.
WorkersWorkAssignmentReportsTo	The view that returns reporting relationships for worker assignments. This view identifies each associate's direct manager or supervisor and supports organizational hierarchy reporting.
WorkersWorkAssignmentsAssignedOrganizationalUnits	The view that returns the organizational units that are assigned to each worker's work assignment. This view links employees to departments or divisions for workforce management and financial reporting.
WorkersWorkAssignmentsAssignedWorkLocations	The view that returns assigned work location data for worker assignments. This view tracks where employees perform their duties, supporting payroll tax jurisdiction and location-based reporting.
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails	The view that returns email contact information that is associated with assigned work locations. This view enables communication with site administrators or location-specific Human Resources (HR) personnel.
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes	The view that returns fax communication data that is associated with assigned work locations. This view preserves site-level fax information for administrative or compliance correspondence.
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines	The view that returns landline phone numbers that are associated with assigned work locations. This view provides fixed-line contact details for Human Resources (HR) and operational communication.
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles	The view that returns mobile phone contact data that is associated with assigned work locations. This view captures mobile communication numbers that are used for coordination and emergency communication.
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers	The view that returns pager contact data that is associated with assigned work locations. This view preserves historical or specialized paging contact records for field or shift-based communication tracking.
WorkersWorkAssignmentsHomeOrganizationalUnits	The view that returns home organizational unit data for worker assignments. This view identifies the primary organizational unit that is associated with each worker for payroll allocation and hierarchy reporting.
WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails	The view that returns email communication information for workers' home work locations. This view provides site-level contact details that are used for administrative coordination.
WorkersWorkAssignmentsHomeWorkLocationCommunicationFaxes	The view that returns fax communication data for workers' home work locations. This view supports Human Resources (HR) and payroll correspondence that requires fax-based communication.
WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines	The view that returns landline communication data for workers' home work locations. This view provides fixed-line contact numbers that are maintained for Human Resources (HR) directory and compliance use.
WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles	The view that returns mobile phone communication data for workers' home work locations. This view supports contact and scheduling coordination for employees based at specific sites.
WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers	The view that returns pager communication data for workers' home work locations. This view retains legacy contact information that can be used in operational or emergency contexts.
WorkersWorkAssignmentsIndustryClassifications	The view that returns industry classification data for worker assignments. This view aligns job functions and departments with industry-standard classification codes that are used in compliance and statistical reporting.
WorkersWorkAssignmentsLinks	The view that returns link data that is associated with worker assignments. This view identifies related entities (for example, departments or projects), enabling relational navigation between worker records and organizational structures.
WorkersWorkAssignmentsOccupationalClassifications	The view that returns occupational classification codes for worker assignments. This view categorizes workers by occupation for regulatory compliance, labor reporting, and analytics.
WorkersWorkAssignmentsWorkerGroups	The view that returns worker group associations within work assignments. This view identifies teams, projects, or groups that workers are assigned to for management and operational reporting.
WorkerTypeCode	The view that provides standardized worker type codes. This view classifies workers according to employment type (for example, full-time, part-time, or contractor) to ensure consistent payroll and Human Resources (HR) reporting.
WorkSchedules	The view that returns worker schedule data. This view defines standard working hours, shift patterns, and time-off rules that are used in scheduling and payroll processing.
WorkSchedulesEntries	The view that returns daily or weekly schedule entries that are defined within work schedules. This view includes shift dates, durations, and assignment details to support time tracking and compliance monitoring.

AdditionalRemunerationNameCode

The view that provides reference data for additional remuneration name codes. This view defines supplemental pay elements (for example, bonuses, commissions, or incentive payments) that are recognized in ADP payroll processing. This view is used to standardize remuneration types across payroll reports and calculations.

Columns


Name	Type	References	Description
CodeValue	String		The unique code value that identifies each additional remuneration name record in ADP. The code value is used to map the remuneration type to its corresponding payroll or benefits configuration.
ShortName	String		The short descriptive name that represents the additional remuneration type. This value provides a human-readable label that is used in payroll setup, reporting, and reference data mappings.

AssociatePaymentsAllocationsEarningsAndBenefits

The view that presents detailed information about how each associate's earnings and benefits are allocated in payroll outputs. This view enables reconciliation of earnings categories with corresponding benefit components to ensure accurate financial reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.

ItemId supports the '=' and IN comparisons.

SELECT * FROM AssociatePaymentsAllocationsEarningsAndBenefits WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsAllocationsEarningsAndBenefits WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that is assigned to each record in the collection. This Id is used to distinguish individual earning or benefit allocation items within an associate's payroll record.
AssociateOID	String		The associate Id that represents the worker to whom the earnings or benefits are allocated. This value links each allocation record to the corresponding worker profile in ADP.
payments	String		The payment element that is associated with each earning or benefit allocation. This column contains payment-specific information that is used to calculate, report, and reconcile payroll amounts for the associate.

AssociatePaymentsAllocationsEarningSections

The view that displays the earning section breakdowns for associate payment allocations. This view organizes payroll results by section (for example, regular pay, overtime, and adjustments) to support payroll review and compliance validation.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.

ItemId supports the '=' and IN comparisons.

SELECT * FROM AssociatePaymentsAllocationsEarningSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsAllocationsEarningSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that is assigned to each record in the collection. This Id is used to distinguish individual earning section items within an associate's payroll allocation record.
AssociateOID	String		The associate Id that identifies the worker to whom the earning section applies. This value links each record to the worker's payroll and employment data in ADP.
ConfigurationTags	String		The configuration tags that are associated with the earning section. These tags are used to categorize or group earning elements for processing, filtering, or reporting purposes.
EarningAmountValue	Double		The total earning amount that is associated with the section. This value represents the calculated pay that is due to the associate for the defined earning category.
EarningClassificationCodeValue	String		The code value that defines the classification of the earning, such as regular pay, overtime, or bonus. This value is used for payroll categorization and compliance reporting.
EarningClassificationCodeShortName	String		The short descriptive name that corresponds to the earning classification code. This field provides a readable label for payroll summaries and Human Resources (HR) reports.
EarningIDDescription	String		The description of the earning Id that explains the purpose or nature of the earning. This field provides context for reporting and payroll configuration.
EarningIDValue	String		The earning Id value that uniquely identifies the specific earning within the payroll configuration. This Id is used to map each earning to its corresponding pay rule or category.
PayRateBaseUnitCodeValue	String		The code value that defines the base unit of measure for the pay rate, such as hourly or salary. This value is used to determine how the pay rate is calculated and displayed.
PayRateBaseUnitCodeShortName	String		The short descriptive name that represents the base unit of pay rate measurement. This field provides a readable reference for HR and payroll administrators.
PayRateValue	Double		The numeric pay-rate value that is applied to the earning section. This value represents the rate at which the associate is compensated for the associated time worked or earning type.
TimeWorkedQuantityValue	Double		The total quantity of time that is worked for the earning section. This value, when combined with the pay rate, determines the total earning amount.
TimeWorkedQuantityunitTimeCodeValue	String		The code value that represents the time unit that is used to measure the time worked, such as hours or days. This value supports consistent time and pay calculations.
TimeWorkedQuantityUnitTimeCodeShortName	String		The short descriptive name that corresponds to the time-unit code. This field provides a clear label for displaying or reporting the time unit in payroll outputs.
DepartmentId	String		The department Id that identifies the cost center or department to which the earning section is charged. This Id enables payroll expense allocation and department-level reporting.

AssociatePaymentsAllocationsNonStatutoryDeductions

The view that returns non-statutory deduction details for associate payment allocations in payroll outputs. This view includes deductions that are not legally mandated, such as employee-elected benefits, charitable contributions, or loan repayments.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.

ItemId supports the '=' and IN comparisons.

SELECT * FROM AssociatePaymentsAllocationsNonStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsAllocationsNonStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that is assigned to each record in the collection. This Id is used to distinguish individual non-statutory deduction entries within an associate's payroll allocation record.
AssociateOID	String		The associate Id that identifies the worker to whom the non-statutory deduction applies. This value links each deduction record to the corresponding worker's payroll profile in ADP.
SectionName	String		The name of the section that is associated with the non-statutory deduction. This value describes the deduction category as it appears in payroll output or reporting, such as Retirement Plan or Union Dues.
SectionCategory	String		The category code that classifies the type of non-statutory deduction. This value determines how the deduction is processed, grouped, and displayed within payroll summaries.
AssociateDeductionTakenAmountValue	Double		The total amount that is deducted from the associate's pay for the specific non-statutory deduction. This amount reflects voluntary deductions that are applied based on worker elections or company policy.
DeductionIDDescription	String		The description of the deduction Id that explains the purpose or definition of the deduction. This field provides additional context for payroll reporting and configuration review.
DeductionIDValue	String		The deduction Id value that uniquely identifies the non-statutory deduction within the payroll configuration. This Id is used to map each deduction to its corresponding deduction rule or benefits setup.
DepartmentId	String		The department Id that identifies the department or cost center responsible for the deduction. This Id supports payroll expense tracking and departmental reconciliation.

AssociatePaymentsAllocationsStatutoryDeductions

The view that displays statutory deduction information for associate payment allocations in payroll outputs. This view includes deductions that are required by law, such as income taxes, social security contributions, and other government withholdings.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.

ItemId supports the '=' and IN comparisons.

SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that is assigned to each record in the collection. This Id is used to distinguish individual statutory deduction entries within an associate's payroll allocation record.
AssociateOID	String		The associate Id that identifies the worker to whom the statutory deduction applies. This value links each deduction record to the corresponding worker's payroll and employment data in ADP.
SectionName	String		The name of the section that is associated with the statutory deduction. This value describes the deduction grouping as it appears in payroll reporting, such as Federal Tax or State Income Tax.
SectionCategory	String		The category code that classifies the statutory deduction type. This value determines how the deduction is processed, grouped, and displayed in payroll summaries and compliance reports.
AssociateDeductionTakenAmountValue	Double		The total amount that is deducted from the associate's pay for the statutory deduction. This amount reflects the required deduction that is applied according to jurisdictional and legal requirements.
AssociateTaxableAmountValue	Double		The taxable amount that is associated with the statutory deduction. This amount represents the portion of the associate's pay that is subject to statutory taxes or withholdings.
ConfigurationTags	String		The configuration tags that are associated with the statutory deduction. These tags are used to categorize, filter, or control deduction behavior within payroll processing and reporting.
EmployerPaidAmountValue	Double		The total amount that is paid by the employer for the statutory deduction. This amount represents employer contributions that are required under tax or benefits regulations.
EmployerTaxableAmountValue	Double		The taxable amount that is associated with the employer-paid portion of the statutory deduction. This field identifies the taxable base that is used for calculating employer contributions.
StatutoryDeductionTypeCodeValue	String		The code that identifies the specific statutory deduction type (for example, Federal Income Tax, Social Security, or Medicare). This code ensures accurate classification within ADP's payroll and compliance framework.
StatutoryDeductionTypeCodeShortName	String		The short descriptive name that corresponds to the statutory deduction-type code. This field provides a readable label for payroll output and compliance documentation.
StatutoryJurisdictionAdministrativeLevel1.codeValue	String		The code that identifies the administrative jurisdiction in which the statutory deduction applies (for example, a state, province, or regional authority). This code supports jurisdiction-based reporting and tax withholding accuracy.
StatutoryJurisdictionWorkedInIndicator	Boolean		The indicator that specifies whether the statutory deduction is based on the jurisdiction in which the associate works. A value of 'true' indicates that the deduction is applied to the work location jurisdiction, while 'false' indicates that it applies to the resident jurisdiction.
DepartmentId	String		The department Id that identifies the department or cost center to which the statutory deduction is allocated. This Id supports department-level reconciliation and financial reporting.

AssociatePaymentsSummaryEarningsAndBenefits

The view that summarizes all earnings and benefits for each associate within a payroll output. This view provides a high-level snapshot for auditing and financial reconciliation of payroll data.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.

ItemId supports the '=' and IN comparisons.

SELECT * FROM AssociatePaymentsSummaryEarningsAndBenefits WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryEarningsAndBenefits WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that is assigned to each record in the collection. This Id distinguishes each earning or benefit summary entry within the associate's payroll record.
AssociateOID	String		The associate Id that identifies the worker whose earnings and benefits are summarized. This Id links the summary record to the corresponding worker profile in ADP.
Payments	String		The payment data that is associated with each earning or benefit summary. This field contains payment details that are used to calculate, report, and reconcile payroll results for the associate.

AssociatePaymentsSummaryEarningsSections

The view that aggregates earnings by section (for example, regular earnings, overtime, or bonuses) for each associate in payroll outputs. This view provides structured data for compliance and reporting purposes.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.

ItemId supports the '=' and IN comparisons.

SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that is assigned to each record in the collection. This Id distinguishes each earning-section summary entry within the associate's payroll record.
AssociateOID	String		The associate Id that identifies the worker whose earnings are represented in the earning-section summary. This Id links the earning section data to the corresponding worker profile in ADP.
ConfigurationTags	String		The configuration tags that are associated with the earning section. These tags are used to classify, group, or filter earnings for payroll processing and reporting.
EarningAmountValue	Double		The total earning amount that is recorded for the section. This amount represents the pay that is due to the associate for the corresponding earning category.
EarningClassificationCodeValue	String		The code that defines the earning classification, such as regular pay, overtime, or bonus. This code is used to categorize earnings for compliance and reporting purposes.
EarningClassificationCodeShortName	String		The short descriptive name that corresponds to the earning classification code. This field provides a readable label for payroll and Human Resources (HR) reporting.
EarningIDDescription	String		The description of the earning Id that explains the purpose or nature of the earning. This description provides additional context for payroll configuration and audit review.
EarningIDValue	String		The earning Id that uniquely identifies the earning definition in the payroll configuration. This Id is used to map earnings to the correct pay rule or category.
PayRateBaseUnitCodeValue	String		The code that defines the base unit of measure for the pay rate, such as hourly or salary. It determines how the pay rate is calculated and displayed in payroll outputs.
PayRateBaseUnitCodeShortName	String		The short descriptive name that represents the base pay-rate unit. This name provides a clear label for HR administrators and payroll analysts.
PayRateRateValue	Double		The pay rate that is applied to the earning section. This rate represents the amount that the associate is compensated per defined unit of time or work.
PayrollAccumulations	String		The payroll accumulation data that is associated with the earning section. This field captures cumulative totals that are used for payroll reconciliation and financial analysis.
TimeWorkedQuantityValue	Double		The total quantity of time that is worked for the earning section. This quantity, when multiplied by the pay rate, determines the total earning amount.
TimeWorkedQuantityUnitTimeCodeValue	String		The code that represents the unit of time that is used to measure the time worked (for example, hours or days). This code ensures consistent calculation across payroll outputs.
TimeWorkedQuantityUnitTimeCodeName	String		The short name that corresponds to the time-unit code. This field provides a human-readable reference for displaying the unit of measure in reports.
DepartmentId	String		The department Id that identifies the department or cost center to which the earning section is allocated. This Id enables department-level reporting and expense tracking.

AssociatePaymentsSummaryNonStatutoryDeductions

The view that summarizes non-statutory deductions for each associate in payroll outputs. This view allows payroll teams to verify optional deductions that are applied according to employee elections or company policies.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.

ItemId supports the '=' and IN comparisons.

SELECT * FROM AssociatePaymentsSummaryNonStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryNonStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that is assigned to each record in the collection. This Id distinguishes each nonstatutory-deduction summary entry within the associate's payroll record.
AssociateOID	String		The associate Id that identifies the worker whose nonstatutory deductions are represented in this summary. This Id links each deduction entry to the corresponding worker profile in ADP.
SectionName	String		The name of the section that is associated with the nonstatutory deduction. This name identifies the deduction grouping (for example, Retirement Plan or Union Dues) as it appears in payroll output.
SectionCategory	String		The category that classifies the type of nonstatutory deduction. This value determines how the deduction is processed, grouped, and displayed in payroll reports.
AssociateDeductionAmountValue	Double		The total deduction amount that is calculated for the associate. This amount represents the gross deduction before any adjustments or employer contributions.
AssociateDeductionTakenAmountValue	Double		The deduction amount that is actually taken from the associate's pay. This amount reflects the finalized withholding that is applied according to company policies or employee elections.
DeductionIDDescription	String		The description of the deduction Id that explains the purpose or definition of the deduction. This description provides context for payroll configuration and auditing.
DeductionIDValue	String		The deduction Id that uniquely identifies the specific nonstatutory deduction within the payroll configuration. This Id is used to map each deduction to its corresponding payroll rule or benefits setup.
PayrollAccumulations	String		The payroll accumulation data that is associated with the nonstatutory deduction. This data tracks cumulative totals that are used for payroll reconciliation and reporting.
DepartmentId	String		The department Id that identifies the department or cost center responsible for the deduction. This Id supports department-level expense tracking and reconciliation.

AssociatePaymentsSummaryPayrollAccumulations

The view that provides cumulative payroll totals for each associate, including accumulated earnings, deductions, and benefits. This view supports audit trail validation and long-term payroll analytics.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.

ItemId supports the '=' and IN comparisons.

SELECT * FROM AssociatePaymentsSummaryPayrollAccumulations WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryPayrollAccumulations WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that is assigned to each record in the collection. This Id distinguishes each payroll-accumulation record within the associate's payroll summary.
AssociateOID	String		The associate Id that identifies the worker whose payroll accumulations are represented in this summary. This Id links the accumulation data to the corresponding worker profile in ADP.
AccumulatedAmountValue	Double		The total accumulated amount that represents the monetary value of all earnings or deductions that are aggregated for the associate across defined payroll periods.
AccumulatedTimeWorkedQuantityValue	Double		The accumulated quantity of time that is worked by the associate. This quantity reflects the total hours or units of time recorded over multiple payroll periods.
AccumulatedTimeWorkedQuantityUnitTimeCodeValue	String		The code that defines the unit of time that is used for accumulated time worked (for example, hours or days). This code ensures consistent measurement across payroll calculations.
AccumulatedTimeWorkedQuantityUnitTimeCodeShortName	String		The short descriptive name that corresponds to the accumulated time-unit code. This field provides a human-readable label for reporting and payroll outputs.
AccumulatorCodeValue	String		The code that identifies the specific accumulator that is used to track payroll totals (for example, year-to-date earnings or tax withholdings). This code enables accurate categorization of accumulated payroll data.
AccumulatorCodeLongName	String		The long descriptive name that represents the payroll accumulator. This field provides a complete label that is used for display in reports or configuration interfaces.
AccumulatorCodeShortName	String		The short name that corresponds to the payroll accumulator code. This name serves as a concise label for payroll reporting and on-screen displays.
AccumulatorDescription	String		The description that explains the purpose or use of the accumulator. This description provides context for how the accumulated value is applied in payroll calculations or compliance reporting.
AccumulatorTimeUnitCodeValue	String		The code that defines the time unit that is used by the accumulator (for example, hours, weeks, or months). This code ensures proper alignment of accumulated time values across payroll periods.
AccumulatorTimeUnitCodeShortName	String		The short descriptive name that corresponds to the accumulator time-unit code. This field provides a simplified label for payroll review and reporting.
DepartmentId	String		The department Id that identifies the department or cost center to which the payroll accumulation is allocated. This Id supports cost tracking and departmental reconciliation.

AssociatePaymentsSummaryStatutoryDeductions

The view that summarizes all statutory deductions (for example, tax withholdings and mandated contributions) for each associate in payroll outputs. This view is used for compliance reporting and reconciliation with government filings.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.

ItemId supports the '=' and IN comparisons.

SELECT * FROM AssociatePaymentsSummaryStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that is assigned to each record in the collection. This Id distinguishes each statutory-deduction summary entry within the associate's payroll record.
AssociateOID	String		The associate Id that identifies the worker whose statutory deductions are represented in this summary. This Id links each deduction entry to the corresponding worker profile in ADP.
SectionCategory	String		The category that classifies the statutory deduction type. This value determines how the deduction is grouped, processed, and reported for payroll and compliance purposes.
SectionName	String		The name of the section that is associated with the statutory deduction. This name identifies the deduction grouping as it appears in payroll output, such as Federal Income Tax or State Income Tax.
AssociateDeductionAmountValue	Double		The total deduction amount that is calculated for the associate. This amount represents the gross deduction before any adjustments or employer contributions.
AssociateDeductionTakenAmountValue	Double		The deduction amount that is actually taken from the associate's pay. This amount reflects the finalized withholding that is applied according to legal requirements and payroll rules.
AssociateTaxableAmountValue	Double		The taxable amount that is associated with the statutory deduction. This amount represents the portion of the associate's pay that is subject to statutory taxes or withholdings.
ConfigurationTags	String		The configuration tags that are associated with the statutory deduction. These tags are used to categorize, filter, or modify deduction processing within payroll configuration.
EmployerPaidAmountValue	Double		The total amount that is paid by the employer for the statutory deduction. This amount represents employer contributions that are required under tax or benefits regulations.
EmployerTaxableAmountValue	Double		The taxable amount that is associated with the employer-paid portion of the statutory deduction. This field identifies the taxable base used to calculate employer contributions.
PayrollAccumulations	String		The payroll accumulation data that is associated with the statutory deduction. This field tracks cumulative totals that are used for reconciliation and compliance reporting.
StatutoryDeductionTypeCodeValue	String		The code that identifies the specific statutory-deduction type (for example, Federal Income Tax, Social Security, or Medicare). This code ensures accurate classification within ADP's payroll and compliance framework.
StatutoryDeductionTypeCodeASortName	String		The short descriptive name that corresponds to the statutory-deduction type code. This field provides a readable label for payroll and compliance documentation.
StatutoryJurisdictionAdministrativeLevel1CodeValue	String		The code that identifies the administrative jurisdiction in which the statutory deduction applies (for example, state, province, or region). This code supports jurisdiction-based reporting and ensures tax accuracy.
StatutoryJurisdictionWorkedInIndicator	Boolean		The indicator that specifies whether the statutory deduction is based on the jurisdiction in which the associate works. A value of 'true' indicates that the deduction is applied to the work-location jurisdiction, while 'false' indicates that it applies to the resident jurisdiction.
DepartmentId	String		The department Id that identifies the department or cost center to which the statutory deduction is allocated. This Id supports department-level reconciliation and financial reporting.

BenefitCoverages

benefit coverages information for an employee.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the AssociateOID column and '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM BenefitCoverages WHERE AssociateOID = 'G3349PZGBADQY8H7'

The rest of the filter is executed client-side within the connector.

Columns


Name	Type	References	Description
CoverageOptionID	String
CoverageOptionName	String
CoverageStatusCodeEffectiveDate	Date
CoverageLevelCodeValue	String
CoverageLevelCodeShortName	String
BenefitCoverageID	String
AssociateOID	String	Workers.AssociateOID

CostCenters

The view that returns the cost center codes configured for the client in ADP. This view enables payroll expense tracking and departmental allocation of labor costs for internal reporting and financial analysis.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following query is processed server side:

	SELECT * FROM CostCenters

Columns


Name	Type	References	Description
Code	String		The code that identifies the cost center. This code is used to classify payroll expenses, assign organizational ownership, and support department-level reporting within ADP.
Description	String		The description that provides the full name or purpose of the cost center. It helps payroll administrators and finance teams interpret cost-center codes in reports and configuration settings.
CompanyCode	String		The code that represents the payroll group or company division that is associated with the cost center. This code ensures that payroll transactions are routed to the correct company entity within ADP.
Active	Boolean		The indicator that specifies whether the cost center is active. A value of 'true' indicates that the cost center is currently in use, while 'false' indicates that it has been deactivated or retired.

DeductionInputCode

The view that provides reference data for deduction input codes. This view defines each deduction type that is supported in payroll calculations, ensuring standardized mapping across payroll configurations.

Columns


Name	Type	References	Description
CodeValue	String		The code that identifies the deduction input type within ADP. This code is used to map specific deductions (for example, benefits or garnishments) to payroll calculation rules.
ShortName	String		The short name that represents the deduction input code. It provides a concise label that is displayed in payroll configuration pages and deduction reports.
Description	String		The description that explains the purpose or definition of the deduction input. This description provides additional context for payroll administrators when configuring or reviewing deduction rules.

EarningInputCode

The view that provides reference data for earning input codes. This view lists earning categories that are used to classify income types such as salary, overtime, or commission in payroll processing.

Columns


Name	Type	References	Description
CodeValue	String		The code that identifies the earning input type within ADP. This code is used to map earnings, such as regular pay, overtime, or bonuses, to payroll calculation rules.
ShortName	String		The short name that represents the earning input code. This field provides a concise label that is displayed in payroll configuration and reporting interfaces.
LongName	String		The long name that provides the full descriptive title of the earning input. This name helps payroll administrators and Human Resources teams distinguish similar earning codes during configuration and audits.
Description	String		The description that explains the purpose or definition of the earning input. This description provides additional context for payroll administrators when reviewing earning setup or validating payroll rules.

GenerationAffixCode

The view that returns standardized legal name affix codes (for example, Jr., Sr., or III). This view ensures consistent associate identity representation across Human Resources (HR) and payroll systems.

Columns


Name	Type	References	Description
CodeValue	String		The code that identifies the legal name affix or suffix (for example, Jr., Sr., or III). This code is used to maintain consistent naming conventions across worker records and Human Resources documentation.
ShortName	String		The short name that represents the legal name affix. This field provides a concise label that is displayed in user interfaces and reports that reference personal identification details.

HighestEducationLevelCode

The view that returns standardized education level codes for associates. This view supports Human Resources (HR) analytics, diversity reporting, and compliance documentation that rely on education data.

Columns


Name	Type	References	Description
CodeValue	String		The code that identifies the highest level of education that is attained by a worker. This code is used for HR analytics, compliance reporting, and demographic tracking in ADP.
ShortName	String		The short name that represents the highest education level code. This field provides a concise label that is displayed in reports, employee records, and configuration interfaces.

JobApplications

The view that returns job-application records that are captured through the ADP recruiting module. It provides applicant data that is used for candidate tracking, evaluation, and onboarding workflows.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following query is processed server side:

	SELECT * FROM JobApplications

Columns


Name	Type	References	Description
ItemID	String		The unique identifier (Id) that is assigned to each job application record. This Id distinguishes each application within the ADP recruiting and hiring system.
RequisitionID	String		The requisition Id that identifies the job opening to which the application belongs. This Id links the application record to the corresponding job requisition in ADP.
RequisitionTitle	String		The title of the job requisition that is associated with the application. This title describes the position that the applicant has applied for.
ClientRequisitionID	String		The client-specific requisition Id that represents the external or customer-facing identifier of the job posting. This Id is used for cross-referencing applications in integrated recruiting systems.
InternalIndicator	Boolean		The indicator that specifies whether the application was submitted through an internal job posting. A value of 'true' indicates that the application was internal, while a value of 'false' indicates that it was external.
ExternalIndicator	Boolean		The indicator that specifies whether the application was submitted through an external job posting. A value of 'true' indicates that the application was external, while a value of 'false' indicates that it was internal.
HiringManagerID	String		The hiring manager Id that identifies the individual responsible for overseeing the job requisition. This Id links the job application to the hiring manager's record.
HiringManagerWorkerID	String		The worker Id that corresponds to the hiring manager's worker profile. This Id connects the hiring manager to the broader Human Resources (HR) data within ADP.
HiringManagerGivenName	String		The given name of the hiring manager who is associated with the job application. This name is used in recruiting reports and communication workflows.
HiringManagerFamilyName	String		The family name of the hiring manager who is associated with the job application. This value appears in recruiting dashboards and application tracking records.
HiringManagerFormattedName	String		The formatted full name of the hiring manager. This field provides a standardized name format that is used in reporting and communication templates.
ApplicationEffectiveDate	Date		The date that indicates when the job application became effective in the system. This date marks when the record was first considered valid for processing.
ApplicationShortName	String		The short name that represents the job application entry. This field provides a concise label used in dashboards and internal tracking.
ApplicationCode	String		The code that identifies the job application type or category. This code supports reporting, grouping, and configuration of application data.
ApplicationPostingChannelID	String		The Id that represents the posting channel through which the application was submitted, such as a career site or internal portal. This Id links the application to its submission source.
ApplicationPostingChannelCode	String		The code that identifies the posting channel that is associated with the job application. This code supports reporting by application source.
ApplicationPostingChannelShortName	String		The short descriptive name that corresponds to the posting channel code. This field provides a human-readable label for display in reports and dashboards.
ApplicationSubmittedByAssociateOID	String		The associate Id that identifies the person who submitted the application. This Id links the submission to the submitting worker's profile, if applicable.
ApplicationSubmittedByGivenName	String		The given name of the person who submitted the application. This value is used for internal audit and reporting purposes.
ApplicationSubmittedByFamilyName	String		The family name of the person who submitted the application. This value complements the given name for reporting and recordkeeping.
ApplicationSubmittedDate	Date		The date that indicates when the application was submitted to ADP. This date is used for tracking application timelines and status metrics.
ApplicantID	String		The applicant Id that identifies the individual who submitted the job application. This Id links the application record to the applicant's personal and contact information.
ApplicantInternalIndicator	Boolean		The indicator that specifies whether the applicant is an internal candidate. A value of 'true' indicates that the applicant is an internal worker, while a value of 'false' indicates that the applicant is external.
ApplicantWotcScreeningShortName	String		The short name that represents the applicant's Work Opportunity Tax Credit (WOTC) screening status. It provides a concise label for use in eligibility and compliance reports.
ApplicantWotcScreeningLongName	String		The long name that provides the full description of the applicant's WOTC screening result. This value supports compliance reporting and audit review.
ApplicantWotcScreeningCode	String		The code that identifies the WOTC screening outcome or category. This code ensures consistent classification across applicant screening data.
ApplicantBackgroundScreeningLongName	String		The long name that describes the applicant's background screening result. This field provides a human-readable description for compliance or HR review.
ApplicantBackgroundScreeningCode	String		The code that identifies the applicant's background screening status or category. This code supports tracking and regulatory reporting.
ApplicantCountryCode	String		The code that identifies the applicant's country of residence. This code supports geographic reporting and compliance validation.
ApplicantCityName	String		The name of the city where the applicant resides. This information supports workforce planning and demographic analysis.
ApplicantCountrySubdivisionType	String		The type of country subdivision, such as state, province, or region, that is associated with the applicant's address. This value standardizes location reporting.
ApplicantCountrySubdivisionShortName	String		The short name that represents the applicant's country subdivision. It provides an abbreviated label used in reports and dashboards.
ApplicantCountrySubdivisionCode	String		The code that identifies the specific country subdivision associated with the applicant's address. This code is used for location-based reporting and analysis.
ApplicantAddressLine1	String		The first line of the applicant's address. This field captures the primary street address or post-office (PO) box that is associated with the applicant's residence.
ApplicantPostalCode	String		The postal code that corresponds to the applicant's address. This code supports mailing validation and geographic reporting.
CommunicationLandlines	String		The applicant's landline phone number that is associated with the job application. This field stores contact details for direct communication.
CommunicationMobiles	String		The applicant's mobile phone number that is associated with the job application. This field is used for messaging, verification, and recruiter contact.
ApplicantGivenName	String		The applicant's given name. This name is stored as part of the personal information associated with the job application.
ApplicantFamilyName	String		The applicant's family name. This value complements the given name to provide the applicant's full legal name.
ApplicantFormattedName	String		The formatted full name of the applicant. This field provides a standardized name format used for communication and reporting.
AppliedLocationItemID	String		The Id that represents the location to which the applicant applied. This Id links the application to the corresponding work location record in ADP.
AppliedLocationCode	String		The code that identifies the work location for the applied position. This code supports reporting and location-based analytics.
AppliedLocationShortName	String		The short descriptive name that represents the applied location. This field provides a human-readable label for display in reports and dashboards.

JobApplicationsCommunicationLandlines

The view that returns candidate landline phone numbers that are associated with job applications. It supports communication record management for recruiting and compliance reporting.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following query is processed server side:

	SELECT * FROM JobApplicationsCommunicationLandlines

Columns


Name	Type	References	Description
ApplicantID	String		The unique identifier (Id) that represents the applicant to whom the landline contact information belongs. This Id links the communication record to the applicant's job application profile in ADP.
ItemID	String		The Id that distinguishes this specific landline record within the applicant's communication details. This Id supports multiple contact entries under a single applicant profile.
AreaDialing	String		The area-dialing code that is associated with the landline number. This code identifies the regional dialing prefix that is required to complete the call.
CountryDialing	String		The country-dialing code that specifies the international dialing prefix for the phone number, such as 1 for the United States or 44 for the United Kingdom.
DialNumber	String		The local phone number that is associated with the applicant's landline. This number is stored without the country or area code and is combined with those values for outbound communication.
FormattedNumber	String		The formatted landline phone number that is displayed in a standardized format. This value combines country, area, and local dialing components for consistency across reports and user interfaces.
NameCodeValue	String		The code that identifies the type or purpose of the landline number (for example, Home, Work, or Other). This code supports classification and filtering of communication details within ADP.

JobApplicationsCommunicationMobiles

The view that returns candidate mobile contact numbers that are linked to job applications. It provides mobile communication details for recruitment correspondence and tracking.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following query is processed server side:

	SELECT * FROM JobApplicationsCommunicationMobiles

Columns


Name	Type	References	Description
ApplicantID	String		The unique identifier (Id) that represents the applicant to whom the mobile phone contact information belongs. This Id links the communication record to the applicant's job application profile in ADP.
ItemID	String		The Id that distinguishes this specific mobile phone record within the applicant's communication details. This Id supports multiple contact entries under a single applicant profile.
AreaDialing	String		The area-dialing code that is associated with the mobile phone number. This code identifies the regional dialing prefix that is required to complete the call.
CountryDialing	String		The country-dialing code that specifies the international dialing prefix for the mobile phone number, such as 1 for the United States or 44 for the United Kingdom.
DialNumber	String		The local phone number that is associated with the applicant's mobile device. This number is stored without the country or area code and is combined with those values for outbound communication.
FormattedNumber	String		The formatted mobile phone number that is displayed in a standardized format. This value combines country, area, and local dialing components for consistency across reports and user interfaces.
NameCodeValue	String		The code that identifies the type or purpose of the mobile phone number (for example, Personal, Work, or Other). This code supports classification and filtering of communication details within ADP.

jobRequisitions

The view that returns job requisition data for open or closed positions. It supports hiring pipeline management and alignment of workforce planning with organizational goals.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following query is processed server side:

	SELECT * FROM JobRequisitions

Columns


Name	Type	References	Description
ItemID	String		The unique identifier (Id) that represents each job requisition record. This Id distinguishes one requisition from another within ADP's recruiting and hiring system.
PostingInstructionsCode	String		The code that identifies the posting instruction type (for example, Internal, External, or Both). This code determines how and where the job requisition is advertised.
PostingInstructionsLongName	String		The long descriptive name that corresponds to the posting instruction code. This field provides a human-readable label for display in reports and recruiting dashboards.
PostingInstructionsInternalIndicator	Boolean		The indicator that specifies whether the job posting is internal. A value of 'true' indicates that the posting is visible only to internal associates, while a value of 'false' indicates that it is open to external applicants.
PostingChannelID	String		The Id that represents the posting channel through which the requisition is distributed, such as a career site, job board, or internal portal. This Id links the requisition to its posting source.
PostingChannelCode	String		The code that identifies the posting channel associated with the job requisition. This code supports filtering and reporting by application source.
PostingChannelShortName	String		The short descriptive name that represents the posting channel. This field provides a concise label for display in configuration interfaces and dashboards.
PostingChannelLongName	String		The long descriptive name that corresponds to the posting channel code. This field provides a full, readable name for use in reports or recruiting exports.
PostingChannelInternetAddress	String		The internet address (URL) of the posting channel. This field contains the web address through which applicants can access the job posting.
PostingChannelExternalIndicator	Boolean		The indicator that specifies whether the posting channel is external. A value of 'true' indicates that the channel is publicly accessible, while a value of 'false' indicates that it is limited to internal audiences.
PostingChannelDefaultIndicator	Boolean		The indicator that specifies whether the posting channel is the default channel for new job postings. A value of 'true' indicates that the channel is selected by default, while a value of 'false' indicates that it must be selected manually.
PostingInstructionsExpireDate	Date		The date that indicates when the job posting expires. This date marks the final day the position is visible to job seekers.
PostingInstructionsResumeRequiredIndicator	Boolean		The indicator that specifies whether a resume is required for the application. A value of 'true' indicates that applicants must submit a resume, while a value of 'false' indicates that it is optional.
PostingInstructionsValidityAttestationIndicator	Boolean		The indicator that specifies whether the job posting requires validity attestation. A value of 'true' indicates that a validity statement is required, while a value of 'false' indicates that it is not.
PostingInstructionsPostDate	Date		The date that indicates when the job requisition was posted. This date is used for tracking and reporting job-posting activity.
LinksHref	String		The hyperlink reference (href) that provides a URL for accessing the job requisition or related API resource.
LinksRel	String		The relationship type (such as self or parent) that defines how the linked resource relates to the current requisition. This field supports navigation within linked data structures.
LinksTitle	String		The title or label of the linked resource. This field provides a descriptive name that is displayed in user interfaces or reports.
SupportedLocaleCodes	String		The list of supported locale codes that are associated with the job posting. Each code represents a language or regional variant in which the requisition can be displayed.
OpeningsNewPositionQuantity	Integer		The number of new positions that are created under the job requisition. This quantity indicates how many openings are to be filled through the requisition.
WorkedInCountry	String		The code that identifies the country in which the position is located or worked. This code supports compliance and geographic reporting.
WorkerTypeCode	String		The code that identifies the worker type for the position (for example, Full-Time, Part-Time, or Contractor). This code is used to categorize requisitions by employment type.
WorkerTypeShortName	String		The short descriptive name that represents the worker type code. This field provides a readable label for display in dashboards and reports.
CompanyName	String		The name of the company or legal entity that owns the job requisition. This value supports multi-company configuration and reporting.
LocationVisibleIndicator	Boolean		The indicator that specifies whether the job location is visible to applicants. A value of 'true' indicates that the location is displayed on the posting, while a value of 'false' hides it from view.
CompensationVisibleIndicator	Boolean		The indicator that specifies whether compensation information is displayed on the job posting. A value of 'true' indicates that compensation is visible to applicants, while a value of 'false' hides this information.
OpeningsFilledQuantity	Integer		The number of positions that have been filled under this requisition. This quantity helps track progress toward fulfilling the total openings.
OrganizationalUnits	String		The organizational units that are associated with the job requisition. These units define departmental ownership and reporting structure within ADP.
OpeningsQuantity	Integer		The total number of openings that are available under this job requisition. This quantity reflects the total positions to be filled.
EvergreenIndicator	Boolean		The indicator that specifies whether the job requisition is evergreen. A value of 'true' indicates that the requisition remains open for ongoing hiring, while a value of 'false' indicates that it has a defined closing date.
ProjectedStartDate	Date		The projected start date for new hires under this requisition. This date provides hiring managers with a target onboarding timeline.
ExternalIndicator	Boolean		The indicator that specifies whether the job requisition is external. A value of 'true' indicates that it is open to external applicants, while a value of 'false' indicates that it is internal only.
VisibleToJobSeekerIndicator	Boolean		The indicator that specifies whether the job posting is visible to job seekers. A value of 'true' indicates that the posting is visible, while a value of 'false' indicates that it is hidden.
LieDetectorAcknowledgementIndicator	Boolean		The indicator that specifies whether a lie detector acknowledgement is required for the job posting. A value of 'true' indicates that the acknowledgement is required, while a value of 'false' indicates that it is not.
HiringManagerID	String		The hiring manager Id that identifies the individual that is responsible for overseeing the requisition. This Id links the requisition to the hiring manager's profile in ADP.
HiringManagerWorkerID	String		The worker Id that corresponds to the hiring manager's worker profile. This Id connects the hiring manager to their employment record in the HR system.
HiringManagerGivenName	String		The given name of the hiring manager that is associated with the requisition. This name appears in dashboards, reports, and communications.
HiringManagerFamilyName	String		The family name of the hiring manager that is associated with the requisition. This name is displayed in reporting and applicant tracking interfaces.
HiringManagerFormattedName	String		The formatted full name of the hiring manager. This field provides a standardized display name for communication and reporting.
ClientRequisitionID	String		The client requisition Id that represents the external Id that is assigned by the client or external system. This Id supports data synchronization between systems.
RequisitionEffectiveDate	Date		The date that indicates when the job requisition becomes effective. This date marks when the position is first valid for posting and recruiting activity.
RequisitionShortName	String		The short name that represents the job requisition. This field provides a concise label that is used in dashboards, reports, and search results.
RequisitionCode	String		The code that identifies the job requisition. This code supports cross-referencing and internal configuration management.
JobCode	String		The code that identifies the job or position definition that is associated with the requisition. This code links the requisition to a standardized job catalog entry.
JobShortName	String		The short name that represents the job code. This field provides a clear and readable label for reports and dashboards.
JobTitle	String		The title of the job that is associated with the requisition. This title is displayed on postings, reports, and recruiting interfaces.
OccupationalClassificationsCode	String		The code that identifies the occupational classification of the position (for example, a job family or role category). This code supports reporting and compliance tracking.
OccupationalClassificationsShortName	String		The short descriptive name that represents the occupational classification code. This field provides a readable label for classification-based reports.
RequisitionLocationsID	String		The Id that represents the location record that is associated with the job requisition. This Id links the requisition to the work location entry in ADP.
RequisitionLocationsPostalCode	String		The postal code that corresponds to the requisition's work location. This code supports geographic reporting and applicant filtering.
RequisitionLocationsCityName	String		The city name that identifies the location of the job posting. This name is displayed to applicants and used in reporting.
RequisitionLocationsCountrySubdivisionLevel1Code	String		The code that identifies the first-level country subdivision (such as state or province) of the work location. This code ensures geographic accuracy in reporting.
RequisitionLocationsAddressLine1	String		The first line of the address for the requisition's work location. This field contains the primary street address or post-office box.
RequisitionLocationsCountryCode	String		The code that identifies the country of the work location. This code ensures consistency in geographic reporting and compliance documentation.
RequisitionLocationsCode	String		The code that identifies the work location record that is associated with the requisition. This code supports linking between requisition data and work location data.
RequisitionLocationsShortName	String		The short descriptive name that represents the requisition's work location. This field provides a readable label for display in dashboards and reports.

JobRequisitionsOrganizationalUnits

The view that returns organizational unit details that are associated with each job requisition. It enables mapping between requisitions and the company's hierarchical structure for planning and reporting.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following query is processed server side:

	SELECT * FROM JobRequisitionsOrganizationalUnits

Columns


Name	Type	References	Description
JobRequisitionID	String		The unique identifier (Id) that represents the job requisition record. This Id links the requisition to its corresponding organizational units in ADP.
OrganizationalUnitID	String		The Id that identifies the organizational unit that is associated with the job requisition. This Id establishes the reporting or departmental relationship between the position and its organizational structure.
typeCodeValue	String		The code that identifies the type of organizational unit (for example, Department, Division, or Region). This code supports classification and filtering of requisition data.
typeCodeShortName	String		The short descriptive name that corresponds to the organizational unit type code. This field provides a concise label for use in reports and dashboards.
nameCodeValue	String		The code that identifies the specific organizational unit name that is linked to the job requisition. This code is used for cross-referencing and reporting.
nameCodeShortName	String		The short descriptive name that represents the organizational unit name code. This field provides a readable label for display in user interfaces and analytics.

MaritalStatusCode

The view that provides standardized marital status codes that are used in associate profiles. It supports HR data accuracy and payroll tax configuration based on filing status.

Columns


Name	Type	References	Description
CodeValue	String		The code that identifies a specific marital status (for example, Single, Married, or Divorced). This code is used to standardize marital status values across ADP's Human Resources and payroll systems.
ShortName	String		The short descriptive name that corresponds to the marital status code. This field provides a concise label for use in reports and user interfaces.
Description	String		The full description that provides additional context for the marital status code. This description helps clarify how each status is interpreted within the organization's HR policies.

OnboardingTemplate

The view that returns onboarding templates that are configured in ADP. Each template defines workflow steps, documentation requirements, and tasks that are applied to new-hire onboarding processes.

Columns


Name	Type	References	Description
ItemID	String		The unique identifier (Id) that represents the onboarding template record. This Id distinguishes one onboarding template from another within ADP's onboarding and hiring system.
Code	String		The code that identifies the onboarding template configuration. This code is used to reference a specific onboarding workflow or checklist when assigning templates to new hires.
Name	String		The name of the onboarding template. This name provides a descriptive label that helps Human Resources teams and hiring managers identify the purpose or scope of the template in reports and dashboards.

PaidTimeOffBalances

The view that returns current paid time-off (PTO) balances for associates. It is used to track available leave accruals, support scheduling, and ensure compliance with company PTO policies.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.

SELECT * FROM PaidTimeOffBalances WHERE AssociateOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String		The unique identifier (Id) that represents the associate whose PTO balance is recorded. This Id links the PTO balance record to the associate's employment profile in ADP.
BalanceTypeCode	String		The code that identifies the type of PTO balance (for example, Vacation, Sick Leave, or Personal Time). This code ensures consistent categorization across payroll and Human Resource (HR) systems.
BalanceTypeLabelName	String		The descriptive name that corresponds to the balance type code. This field provides a human-readable label for use in reports and employee self-service views.
TotalQuantityValueNumber	Double		The total quantity of time that is available under the specific PTO balance type. This quantity reflects the cumulative hours or days accrued as of the reporting date.
TotalQuantityUnitTimeCode	String		The code that identifies the unit of time (for example, Hours or Days) that is associated with the PTO balance. This code ensures correct interpretation of the total quantity.
TotalQuantityLabelName	String		The descriptive label that represents the time unit of the PTO balance. This label is displayed in reports and employee dashboards.
TotalTime	String		The total time that is associated with the PTO balance. This field provides an alternate display value for the total accrued time.
AccrualBalances	String		The accrual balance details that are associated with the PTO policy. This field provides information about accrual calculations, carryovers, or limits applied to the associate's balance.
PaidTimeOffEntries	String		The individual PTO entries that are associated with the current balance. Each entry represents a recorded accrual, adjustment, or usage transaction within ADP.
PaidTimeOffPolicyCode	String		The code that identifies the PTO policy under which the balance is calculated. This code links the balance record to the appropriate accrual and usage rules.
PaidTimeOffPolicyLabelName	String		The descriptive name that corresponds to the PTO policy code. This field provides a readable label for HR teams and managers when reviewing balances or applying adjustments.
AsOfDate	Date		The date that indicates when the PTO balance is valid. This date is used to determine the point-in-time snapshot of the associate's available time.
PositionRefPositionID	String		The position Id that identifies the associate's current job position. This Id links the PTO balance to the associate's position record for organizational reporting.
PositionRefSchemeName	String		The name of the reference scheme that is associated with the position record. This value identifies the structure or naming convention used for position references.
PositionRefSchemeAgencyName	String		The name of the agency or system that manages the position reference scheme. This value helps distinguish references that originate from different HR or payroll systems.
PositionReftitle	String		The title of the position that is associated with the PTO balance record. This field provides a human-readable title for reporting and display purposes.

PaidTimeOffRequestEntries

The view that returns associate paid time-off (PTO) requests, including dates, hours, and request statuses. It supports HR workflows that manage approvals, scheduling, and payroll synchronization.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.

SELECT * FROM PaidTimeOffRequestEntries WHERE AssociateOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String		The unique identifier (Id) that represents the associate who submitted the PTO request. This Id links the PTO request entry to the associate's employment record in ADP.
RequestID	String		The Id that identifies the overall PTO request record. This Id groups individual time-off entries that are associated with the same request submission.
timeOffEntryID	String		The Id that identifies a specific time-off entry within the overall PTO request. This Id distinguishes individual date ranges or time segments in multi-day requests.
paidTimeOffID	String		The Id that represents the PTO record that is associated with this entry. This Id links the request entry to the corresponding balance or policy record.
paidTimeOffPolicyCode	String		The code that identifies the PTO policy that governs this request. This code ensures that accrual rules, eligibility, and limits are applied according to company policy.
paidTimeOffPolicyLabelName	String		The descriptive name that corresponds to the PTO policy code. This field provides a readable label for Human Resources (HR) and payroll teams when reviewing time-off requests.
EntryStatusCode	String		The code that identifies the current status of the PTO entry (for example, Pending, Approved, or Denied). This code supports workflow tracking and reporting.
EntryStatusLabelName	String		The descriptive name that corresponds to the entry status code. This field provides a human-readable label for display in dashboards and self-service applications.
EarningTypeCode	String		The code that identifies the earning type that is associated with the PTO entry (for example, Paid Leave or Unpaid Leave). This code ensures that payroll calculations are applied correctly.
EarningTypeName	String		The descriptive name that corresponds to the earning type code. This field provides a clear label for use in HR and payroll reporting.
StartDate	Date		The start date of the requested time-off period. This date marks the beginning of the associate's scheduled leave.
EndDate	Date		The end date of the requested time-off period. This date marks when the associate is expected to return or when the leave concludes.
startTime	String		The start time of the requested leave on the first day of absence. This value helps define partial-day or hourly leave requests.
TotalQuantityvalueNumber	String		The total quantity of time that is requested for the PTO entry. This quantity represents the total hours or days covered by the request.
TotalQuantityunitTimeCode	String		The code that identifies the unit of time, such as Hours or Days, that is associated with the total quantity. This code ensures consistency in reporting and calculation.
TotalQuantitylabelName	String		The descriptive label that corresponds to the time unit for the PTO entry. This field provides a readable value for dashboards and approval views.
Meta	String		The metadata that is associated with the PTO request entry. This field can contain system-generated attributes or additional context used for auditing and integration purposes.

PaidTimeOffRequests

The view that returns detailed records of paid time-off (PTO) requests that are submitted by associates. It includes information such as request dates, hours, reasons, and approval statuses. This view is used to track leave management and synchronize approved requests with payroll and scheduling systems.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.

SELECT * FROM PaidTimeOffRequests WHERE AssociateOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String		The unique identifier (Id) that represents the associate who submitted the PTO request. This Id links the request record to the associate's employment profile in ADP.
RequestID	String		The Id that identifies the PTO request record. This Id groups all related time-off entries under a single submission in the ADP system.
RequestStatusCode	String		The code that identifies the current status of the PTO request (for example, Pending, Approved, or Denied). This code supports workflow tracking and process automation.
RequestStatusLabelName	String		The descriptive name that corresponds to the request status code. This field provides a human-readable label for reports, dashboards, and manager views.
TotalQuantityvalueNumber	String		The total quantity of time that is requested in the PTO record. This quantity represents the total hours or days covered by the request.
TotalQuantityunitTimeCode	String		The code that identifies the unit of time (for example, Hours or Days) that is associated with the total quantity. This code ensures correct interpretation and calculation across systems.
TotalQuantitylabelName	String		The descriptive label that corresponds to the time unit for the PTO request. This label provides a readable display value in reports and self-service pages.
TotalTime	String		The total time value that represents the overall length of the PTO request. This field can include formatted duration data that is used for summary display.
paidTimeOffEntries	String		The individual PTO entries that are associated with the current request. Each entry represents a specific date range or time segment of the overall request.
RequestURI	String		The uniform resource identifier (URI) that points to the detailed PTO request record. This URI provides a link reference for integration or API access.
RequestDesc	String		The description that provides additional context or notes for the PTO request. This field can contain system-generated comments or employee-entered explanations.
RequestStartDate	Date		The start date of the requested time-off period. This date marks when the associate's leave is scheduled to begin.
MetadataEntitlementCodes	String		The entitlement codes that are associated with the PTO request. These codes identify the specific leave types or balances that are applied during the request process.
MetaMultiPeriodRequestIndicator	Boolean		The indicator that specifies whether the PTO request spans multiple pay periods. A value of 'true' indicates that the request covers more than one pay period, while a value of 'false' indicates that it is contained within a single pay period.
Actions	String		The available actions that are associated with the PTO request (for example, Approve, Deny, or Cancel). These actions determine the possible next steps in the approval workflow.
RequestorComment	String		The comment that is entered by the associate when submitting the PTO request. This comment provides additional information for the approver or Human Resources (HR) reviewer.
ApprovalDueDate	Date		The date that indicates when approval is due for the PTO request. This date supports timely workflow management and escalation tracking.
PositionRefPositionID	String		The position Id that identifies the associate's current job position. This Id links the PTO request to the position record for organizational reporting.
PositionRefSchemeName	String		The name of the reference scheme that is associated with the position record. This name identifies the structure or naming convention used for position references.
PositionRefSchemeAgencyName	String		The name of the agency or system that manages the position reference scheme. This field distinguishes references that originate from different HR or payroll systems.
PositionReftitle	String		The title of the position that is associated with the PTO request. This title provides a readable reference for display in reports and dashboards.

PayrollGroup

The view that returns payroll-group information that is configured in ADP. A payroll group defines a collection of workers that share the same payroll cycle, frequency, and processing rules. This view supports payroll scheduling, grouping, and administrative reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

Category supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PayrollGroup WHERE Category = 'US'

Columns


Name	Type	References	Description
Code	String		The code that identifies the payroll group. This code defines a specific payroll configuration that is used to organize employees who share the same pay cycle, schedule, or processing rules.
Name	String		The name of the payroll group. This name provides a descriptive label for Human Resources and payroll teams to easily identify the group in reports and configuration screens.
Category	String		The category that classifies the payroll group (for example, Hourly, Salaried, or Commission). This category supports reporting and payroll segmentation across employee types.

PayrollMemos

The view that returns payroll memo entries that are used to record messages, notes, or instructions that are related to payroll processing. Payroll administrators use these memos to document special adjustments, approvals, or compliance notes for each pay run.

Columns


Name	Type	References	Description
ItemID	String	PayrollRuns.ItemID	The unique identifier (Id) that represents the payroll memo record. This Id distinguishes each memo entry within the payroll data collection in ADP.
AssociateOID	String		The Id that identifies the associate to whom the payroll memo applies. This Id links the memo entry to the associate's employment and payroll records.
MemoIDDescription	String		The description that explains the purpose or type of the payroll memo. This description provides context for manual adjustments, system-generated notes, or informational entries in payroll.
MemoIDValue	String		The Id that identifies the specific memo definition or reference. This Id supports categorization and retrieval of memo details during payroll processing.
MemoIDAlternateDescriptions	String		The alternate descriptions that are associated with the memo record. These descriptions provide additional context or translations that are used in reporting and system integration.
MemoAmountValue	Double		The monetary amount that is associated with the payroll memo. This amount represents either an informational value or a financial adjustment (for example, a correction or special payment).
ConfigurationTags	String		The configuration tags that are associated with the payroll memo. These tags help categorize, filter, or report on memo entries according to payroll rules and configurations.

PersonalContacts

The view that returns personal and emergency contact information for each associate. This view includes contact names, relationships, and communication details. This view supports compliance with workplace safety and Human Resources (HR) record-keeping requirements.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the AssociateOID column and '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM PersonalContacts WHERE AssociateOID = 'G3349PZGBADQY8H7'

The rest of the filter is executed client-side within the connector.

Columns


Name	Type	References	Description
PersonName	String		The full name of the personal contact that is associated with the associate's record. This field identifies the individual designated as an emergency or personal contact in ADP.
AddressLine1	String		The first line of the contact's address. This field typically contains the street address or primary location information.
AddressLine2	String		The second line of the contact's address. This field provides space for apartment, suite, or building details that are associated with the contact.
AddressLine3	String		The third line of the contact's address. This field is used for additional address information when needed for international or multi-line formatting.
AddressCityName	String		The name of the city in which the contact resides. This value supports location-based reporting and correspondence.
AddressCountrySubdivisionLevel1SubdivisionType	String		The type of country subdivision (for example, State, Province, or Region) that is associated with the contact's address. This field standardizes geographic categorization.
AddressCountrySubdivisionLevel1Code	String		The code that identifies the first-level country subdivision that corresponds to the contact's address. This code ensures regional accuracy in HR records and reporting.
AddressCountrySubdivisionLevel1ShortName	String		The short descriptive name that represents the first-level country subdivision code. This field provides a readable label for use in dashboards and reports.
AddressCountrySubdivisionLevel1LongName	String		The long descriptive name that corresponds to the first-level country subdivision code. This field provides a complete region or state name for display and documentation.
AddressCountryCode	String		The code that identifies the country of the contact's address. This code ensures proper international standardization across ADP systems.
AddressPostalCode	String		The postal code that is associated with the contact's address. This value supports mailing accuracy and regional analysis.
CommunicationLandlines	String
CommunicationMobiles	String
CommunicationEmails	String
ContactTypeCode	String		The code that identifies the type of contact (for example, Emergency, Personal, or Dependent). This code supports classification and prioritization of contacts.
ContactTypeCodeShortName	String		The short descriptive name that corresponds to the contact type code. It provides a concise label for use in reports and HR systems.
RelationshipTypeCode	String		The code that identifies the type of relationship between the associate and the contact (for example, Spouse, Parent, or Friend). This code supports accurate representation of personal relationships in HR records.
RelationshipTypeCodeShortName	String		The short descriptive name that corresponds to the relationship type code. This field provides a readable label for dashboards and reporting.
PrecedenceCode	String		The code that identifies the contact precedence or ranking order (for example, Primary or Secondary). This code determines the order of priority when multiple contacts exist.
PrecedenceCodeShortName	String		The short descriptive name that corresponds to the precedence code. This field provides a readable label for use in dashboards and contact lists.
ItemID	String		The unique identifier (Id) that represents the personal contact record. This Id distinguishes one contact entry from another within the associate's profile.
AssociateOID	String	Workers.AssociateOID	The Id that identifies the associate to whom the personal contact belongs. This Id links the contact record to the associate's employment data in ADP.

QualificationAffixCode

The view that provides standardized codes for worker-qualification affixes. This view defines credential suffixes and related classification codes that are applied to worker records to indicate certifications, degrees, or titles.

Columns


Name	Type	References	Description
CodeValue	String		The code that identifies a specific qualification affix (for example, PhD, MBA, or CPA). This code is used to classify or display professional titles and certifications within ADP's Human Resources (HR) records.
ShortName	String		The short descriptive name that corresponds to the qualification affix code. This field provides an abbreviated label for reports, dashboards, and employee profile summaries.
LongName	String		The long descriptive name that corresponds to the qualification affix code. This field provides the full spelling of the credential or title for use in documentation and formal reporting.
Description	String		The description that explains the context or purpose of the qualification affix. This field clarifies how each code is applied within HR and employee credential tracking.

ReimbursementInputCode

The view that provides reference data for reimbursement input codes. This view lists reimbursement types (for example, travel, mileage, or expenses) that are used in payroll processing. The view enables standardized mapping of reimbursement categories.

Columns


Name	Type	References	Description
CodeValue	String		The code that identifies the reimbursement input type (for example, Travel, Meals, or Training). This code is used to classify reimbursement transactions within ADP's payroll and expense processing systems.
ShortName	String		The short descriptive name that corresponds to the reimbursement input code. This field provides a concise label for reports, configuration screens, and payroll summaries.
Description	String		The description that explains the purpose or use of the reimbursement input code. This field clarifies how each reimbursement category is applied during payroll and reimbursement processing.

TeamTimeCards

The view that returns time card data for all workers in a specific team. This view includes time entries, attendance records, and worked hours. This view supports team-level scheduling, payroll validation, and labor reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the connector.

ManagerOID supports the '=' comparison.

SELECT * FROM TeamTimeCards WHERE ManagerOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate whose time card record is being processed. This Id links the time entry to the associate's employment profile in ADP.
WorkerID	String		The Id that identifies the worker that is associated with the team time card. This Id connects the worker's time data to related payroll and scheduling records.
TimeCardID	String		The Id that identifies the time card record for the current payroll period. This Id distinguishes each time card entry within the associate's time-tracking data.
PersonLegalName	String		The legal name of the associate as recorded in Human Resources (HR) systems. This name is used for reporting, compliance, and time card identification.
PersonLegalFamilyName1	String		The first family name or surname of the associate. This field supports naming consistency across ADP's HR and payroll modules.
PersonLegalFormattedName	String		The formatted full legal name of the associate. This field provides a standardized name format for display in reports and dashboards.
ProcessingStatusCodeValue	String		The code that identifies the processing status of the time card (for example, Draft, Submitted, or Approved). This code supports time card workflow tracking.
ProcessingStatusCodeShortName	String		The short descriptive name that corresponds to the processing status code. This field provides a readable label for display in reports and dashboards.
periodCodeValue	String		The code that identifies the time-tracking period that the time card represents (for example, Current, Next, or Previous). This code determines which pay period's data is being viewed or processed.
periodCodeShortName	String		The short descriptive name that corresponds to the period code. This field provides a concise label for use in dashboards and reports.
periodCodeLongName	String		The long descriptive name that corresponds to the period code. This field provides the full label used in reports and time-tracking summaries.
TimePeriodStartDate	String		The start date of the time card period. This date marks when the pay or work period begins.
TimePeriodEndDate	String		The end date of the time card period. This date marks when the pay or work period concludes.
TimePeriodPeriodStatus	String		The status of the time period that the time card represents (for example, Open, Closed, or Locked). This value supports payroll readiness and workflow control.
PositionID	String		The Id that identifies the associate's job position that is linked to the time card. This Id connects time records to position-based reporting and labor cost allocation.
PeriodTotals	String		The summarized totals for the time card period. This field aggregates hours, earnings, or other time-based values for reporting and payroll processing.
DailyTotals	String		The daily totals that are associated with the time card. Each entry represents the total worked time or pay data for a single day within the period.
TotalPeriodTimeDuration	String		The total time duration that is recorded across the entire time card period. This value reflects the cumulative worked or payable time for the associate.
HomeLaborAllocations	String		The home labor allocation details that are associated with the time card. These details indicate the cost center or department where the associate's time is charged.
ExceptionsIndicator	Boolean		The indicator that specifies whether any exceptions exist in the time card record. A value of 'true' indicates that exceptions are present (for example, missing punches or policy violations), while a value of 'false' indicates that the time card has no exceptions.
ManagerOID	String	Workers.AssociateOID	The Id that identifies the manager who is responsible for approving or reviewing the associate's time card. This Id links the record to the manager's profile in ADP.

TeamTimeCardsAllTeams

The view that returns time card data for all teams within the organization. This view consolidates multiple team records into a single dataset for workforce management and payroll reconciliation.

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate whose time card record appears in the all-teams view. This Id links the time entry to the associate's employment profile in ADP.
WorkerID	String		The Id that identifies the worker that is associated with the time card entry across all teams. This Id connects the worker's time data to related payroll and scheduling records.
TimeCardID	String		The Id that identifies the time card record for the specified payroll period. This Id distinguishes each time card entry within the associate's time-tracking data across multiple teams.
PersonLegalName	String		The legal name of the associate as recorded in Human Resources (HR) systems. This name is used for compliance, reporting, and identification within team time card records.
PersonLegalFamilyName1	String		The first family name or surname of the associate. This value ensures naming consistency across ADP's HR and payroll modules.
PersonLegalFormattedName	String		The formatted full legal name of the associate. This field provides a standardized name format for display in reports and dashboards.
ProcessingStatusCodeValue	String		The code that identifies the processing status of the time card (for example, Draft, Submitted, or Approved). This code supports time card workflow tracking across teams.
ProcessingStatusCodeShortName	String		The short descriptive name that corresponds to the processing status code. This field provides a readable label for reports and dashboards.
periodCodeValue	String		The code that identifies the time-tracking period that the time card represents (for example, Current, Next, or Previous). This code determines which pay period's data is being viewed or processed.
periodCodeShortName	String		The short descriptive name that corresponds to the period code. This field provides a concise label for display in reports and dashboards.
periodCodeLongName	String		The long descriptive name that corresponds to the period code. This field provides the full label used in reports and time-tracking summaries.
TimePeriodStartDate	Date		The start date of the time card period. This date marks when the pay or work period begins.
TimePeriodEndDate	Date		The end date of the time card period. This date marks when the pay or work period concludes.
TimePeriodPeriodStatus	String		The status of the time period that the time card represents (for example, Open, Closed, or Locked). This status supports payroll readiness and approval workflows.
PositionID	String		The Id that identifies the associate's job position that is linked to the time card. This Id connects time records to position-based reporting and labor cost allocation.
PeriodTotals	String		The summarized totals for the time card period. This field aggregates hours, earnings, or other time-based values for reporting and payroll processing.
DailyTotals	String		The daily totals that are associated with the time card. Each entry represents the total worked time or pay data for a single day within the period.
TotalPeriodTimeDuration	String		The total time duration that is recorded across the entire time card period. This value reflects the cumulative worked or payable time for the associate.
HomeLaborAllocations	String		The home-labor allocation details that are associated with the time card. These details identify the cost center or department where the associate's time is charged.
ExceptionsIndicator	Boolean		The indicator that specifies whether any exceptions exist in the time card record. A value of 'true' indicates that exceptions are present (for example, missing punches or policy violations), while a value of 'false' indicates that the time card has no exceptions.
ManagerOID	String	Workers.AssociateOID	The Id that identifies the manager who oversees or approves the time cards for multiple teams. This Id links the time card record to the manager's profile in ADP.

TeamTimeCardsDailyTotals

The view that returns aggregated daily totals from team time cards. This view summarizes the total hours that are worked by team and day, enabling supervisors to monitor attendance patterns and manage overtime compliance.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the connector.

ManagerOID supports the '=' comparison.

SELECT * FROM TeamTimeCardsDailyTotals WHERE ManagerOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate whose daily time card total is recorded. This Id links the daily totals to the associate's employment and payroll records in ADP.
WorkerID	String		The Id that identifies the worker that is associated with the team time card. This Id connects the worker's daily totals to related payroll and scheduling data.
TimeCardID	String		The Id that identifies the time card record for the current pay period. This Id distinguishes daily total entries within the overall time card record.
EntryDate	Date		The date that corresponds to the daily time card entry. This date represents the specific day for which time and pay data are recorded.
PayCodeCodeValue	String		The code that identifies the pay category for the daily entry (for example, Regular Hours, Overtime, or Holiday Pay). This code determines how the time is classified for payroll calculation.
RateBaseMultiplierValue	String		The multiplier that is applied to the base pay rate for the day. This value is used to calculate earnings adjustments (for example, overtime or shift differentials).
RateAmountValue	Double		The pay rate that applies to the time recorded for the day. This rate determines the amount paid to the associate for the specified work period.
RateCurrencyCode	String		The currency code that specifies the monetary unit for the pay rate (for example, USD or CAD). This code ensures that daily pay calculations are performed in the correct currency.
TimeDuration	String		The total time duration that is recorded for the day. This value represents the total worked, paid, or payable time for the daily entry.
HomeLaborAllocations	String		The home-labor allocation details that are associated with the daily time card entry. These details identify the cost center or department where the associate's time is charged.
DayEntries	String		The detailed daily time entries that are associated with the record. Each entry can represent a separate segment of worked time or pay category within the day.
ManagerOID	String	Workers.AssociateOID	The Id that identifies the manager who oversees the associate's daily time card entries. This Id links the record to the manager's profile for review and approval workflows.
periodCodeValue	String		The code that identifies the time-tracking period that the daily total belongs to (for example, Current, Next, or Previous). This code determines which pay period's data is being viewed or processed.
TimePeriodStartDate	String		The start date of the time card period to which the daily total belongs. This date marks when the payroll or work period begins.
TimePeriodEndDate	String		The end date of the time card period to which the daily total belongs. This date marks when the payroll or work period concludes.

TeamTimeCardsDayEntries

The view that returns daily time card entries for each worker, along with associated totals. This view provides a day-by-day breakdown of team activity that is used to verify attendance, validate time entries, and approve hours for payroll.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions that are built with the following column and operator. The ManagerOID column is required to make a request and the rest of the filter is executed client side within the connector.

ManagerOID supports the '=' comparison.

SELECT * FROM TeamTimeCardsDayEntries WHERE ManagerOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate whose daily time card entry is being recorded. This Id links the daily entry to the associate's employment and payroll data in ADP.
WorkerID	String		The Id that identifies the worker that is associated with the daily time card entry. This Id connects the entry to payroll and scheduling systems for accurate time-tracking.
TimeCardID	String		The Id that identifies the time card record for the specified payroll period. This Id distinguishes day entries within the broader time card record.
EntryDate	Date		The date that corresponds to the daily time card entry. This date specifies when the recorded work or payable event occurred.
TotalPeriodTimeDuration	String		The total time duration recorded for the payroll period to which the day entry belongs. This value reflects the cumulative time across all entries in the time card.
TimeEntryID	String		The Id that identifies the specific time entry within the daily record. This Id distinguishes individual work or pay segments for the associate.
TimeEntryTypeCode	String		The code that identifies the type of time entry (for example, Regular Hours, Overtime, or Sick Leave). This code determines how the entry is processed for payroll calculation.
TimeEntryStartPeriod	String		The start time of the period that is covered by the time entry. This time marks when the work or paid activity began.
TimeEntryEndPeriod	String		The end time of the period that is covered by the time entry. This time marks when the work or paid activity concluded.
TimeEntryLaborAllocations	String		The labor allocation details that are associated with the time entry. These details identify the cost center or department where the associate's time is charged.
TimeEntryExceptions	String		The list of exceptions that are associated with the time entry. Each exception represents a variance from policy or expected time-tracking behavior (for example, a missed punch or early departure).
TimeEntryTimeDuration	String		The total time duration that is recorded for the time entry. This value reflects the specific length of the work or paid period.
TimeEntryActions	String		The actions that are associated with the time entry (for example, Edit, Approve, or Delete). These actions define the available operations for managing the entry.
TimeEntryStatusCodeValue	String		The code that identifies the current status of the time entry (for example, Draft, Submitted, or Approved). This code supports workflow and approval tracking.
TimeEntryStatusShortName	String		The short descriptive name that corresponds to the time entry status code. This field provides a concise label for use in reports and dashboards.
TimeEntryTotalsPayCodeValue	String		The pay code that is associated with the total for the time entry (for example, Regular Pay or Overtime Pay). This code defines how the recorded time is classified for payroll.
TimeEntryTotalsRateMultiplier	String		The multiplier that is applied to the base pay rate for the time entry. This value is used for earnings adjustments (for example, overtime or shift differential).
TimeEntryTotalsRateAmountValue	String		The pay rate that applies to the time recorded for the entry. This rate determines the amount payable for the specified period.
TimeEntryTotalsRateCurrencyCode	String		The currency code that specifies the monetary unit for the pay rate (for example, USD or CAD). This code ensures accurate payroll calculations across regions.
TimeEntryTotalsTimeDuration	String		The total time duration that is associated with the pay code total. This value represents the amount of time that contributes to payroll for that specific entry.
ManagerOID	String	Workers.AssociateOID	The Id that identifies the manager who oversees the associate's day-level time entries. This Id links the entries to the appropriate approver for workflow processing.
periodCodeValue	String		The code that identifies the time-tracking period that the day entry belongs to (for example, Current, Next, or Previous). This code determines which payroll period the data applies to.
TimePeriodStartDate	String		The start date of the time card period to which the day entry belongs. This date marks when the payroll or work period begins.
TimePeriodEndDate	String		The end date of the time card period to which the day entry belongs. This date marks when the payroll or work period concludes.

TeamTimeCardsHomeLaborAllocations

The view that returns home-labor allocation data for team time cards. This view identifies how hours worked are distributed across home cost centers, locations, or projects. This view supports labor allocation and cost accounting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the connector.

ManagerOID supports the '=' comparison.

SELECT * FROM TeamTimeCardsHomeLaborAllocations WHERE ManagerOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate whose labor allocation is recorded for the time card. This Id links the allocation data to the associate's employment and payroll information in ADP.
WorkerID	String		The Id that identifies the worker that is associated with the home labor allocation. This Id connects the allocation entry to related payroll and scheduling records.
TimeCardID	String		The Id that identifies the time card record for the associate. This Id distinguishes the labor allocation within the broader time card entry.
AllocationCode	String		The code that identifies the home labor allocation (for example, a department, project, or cost center). This code determines where the associate's time is charged for payroll and reporting purposes.
AllocationTypeCodeValue	String		The code that specifies the type of labor allocation (for example, Primary Department or Job Function). This value defines the classification of the work performed.
AllocationTypeCodeShortName	String		The short descriptive name that corresponds to the labor-allocation type code. This field provides a readable label for display in time-tracking and payroll reports.
ManagerOID	String	Workers.AssociateOID	The Id that identifies the manager responsible for overseeing the associate's labor allocation. This Id links the allocation record to the manager's profile in ADP.
periodCodeValue	String		The code that identifies the time-tracking period that the allocation applies to (for example, Current, Next, or Previous). This code determines which payroll period the data belongs to.
TimePeriodEndDate	String		The end date of the time card period that the allocation covers. This date marks when the payroll or work period concludes.

TeamTimeCardsPeriodTotals

The view that returns aggregated period totals from team time cards. This view summarizes total hours, regular pay, and overtime over a complete payroll period. This data supports payroll calculation and compliance with labor regulations.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the connector.

ManagerOID supports the '=' comparison.

SELECT * FROM TeamTimeCardsPeriodTotals WHERE ManagerOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate whose payroll-period total is recorded. This Id links the period totals to the associate's employment and payroll information in ADP.
WorkerID	String		The Id that identifies the worker that is associated with the payroll-period total. This Id connects the total to the worker's time-tracking and payroll records.
TimeCardID	String		The Id that identifies the time card record for the specified payroll period. This Id distinguishes the period totals from other entries in the associate's time card.
payCodecodeValue	String		The code that identifies the pay category used to calculate the period total (for example, Regular Pay, Overtime, or Holiday). This code defines how the time and earnings are classified for payroll processing.
RateBaseMultiplierValue	String		The multiplier that is applied to the base pay rate for the payroll period. This value adjusts the base rate when calculating earnings (for example, for overtime or differential pay).
RateAmountValue	Double		The pay rate that applies to the time recorded for the payroll period. This rate determines the total payable amount for the associated time and pay category.
RateCurrencyCode	String		The currency code that specifies the monetary unit for the pay rate (for example, USD or CAD). This code ensures accurate payroll calculations across regional and international operations.
TimeDuration	String		The total time duration that is recorded for the payroll period. This value represents the total worked or payable time accumulated across all days in the period.
ManagerOID	String	Workers.AssociateOID	The Id that identifies the manager responsible for approving or reviewing the associate's payroll period totals. This Id links the totals to the manager's profile for approval workflows.
periodCodeValue	String		The code that identifies the time-tracking period that the totals apply to (for example, Current, Next, or Previous). This code determines which payroll period the data belongs to.
TimePeriodStartDate	String		The start date of the payroll period to which the totals belong. This date marks when the work or pay cycle begins.
TimePeriodEndDate	String		The end date of the payroll period to which the totals belong. This date marks when the work or pay cycle concludes.

TimeCards

The view that returns time card data for individual workers. This view includes daily and period totals, job codes, and pay types. This view supports time tracking, payroll preparation, and compliance with attendance policies.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.

SELECT * FROM TimeCards WHERE AssociateOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate whose time card record is being processed. This Id links the time entry to the associate's employment and payroll information in ADP.
WorkerID	String		The Id that identifies the worker that is associated with the time card record. This Id connects the worker's time data to payroll and scheduling records.
TimeCardID	String		The Id that identifies the time card record for the payroll period. This Id distinguishes each time card entry in the associate's time-tracking data.
PersonLegalName	String		The legal name of the associate as recorded in Human Resources (HR) systems. This name is used for reporting, compliance, and time card identification.
PersonLegalFamilyName1	String		The first family name or surname of the associate. This value supports naming consistency across ADP's HR and payroll modules.
PersonLegalFormattedName	String		The formatted full legal name of the associate. This field provides a standardized name format for display in reports and dashboards.
ProcessingStatusCodeValue	String		The code that identifies the processing status of the time card (for example, Draft, Submitted, or Approved). This code supports time card workflow tracking.
ProcessingStatusCodeShortName	String		The short descriptive name that corresponds to the processing status code. This field provides a readable label for use in dashboards and reports.
periodCodeValue	String		The code that identifies the time-tracking period that the time card represents (for example, Current, Next, or Previous). This code determines which pay period's data is being viewed or processed.
periodCodeShortName	String		The short descriptive name that corresponds to the period code. This field provides a concise label for display in reports and dashboards.
periodCodeLongName	String		The long descriptive name that corresponds to the period code. This field provides the full label that is used in reports and time-tracking summaries.
TimePeriodStartDate	String		The start date of the time card period. This date marks when the pay or work period begins.
TimePeriodEndDate	String		The end date of the time card period. This date marks when the pay or work period concludes.
TimePeriodPeriodStatus	String		The status of the time period that the time card represents (for example, Open, Closed, or Locked). This value supports payroll readiness and workflow control.
PositionID	String		The Id that identifies the associate's job position that is linked to the time card. This Id connects time records to position-based reporting and labor cost allocation.
ExceptionCounts	String		The number of time-tracking exceptions that are associated with the time card. Each exception represents an issue that must be reviewed before payroll approval (for example, a missed punch or overtime violation).
PeriodTotals	String		The summarized totals for the time card period. This field aggregates hours, earnings, or other time-based values for reporting and payroll processing.
DailyTotals	String		The daily totals that are associated with the time card. Each entry represents the total worked time or pay data for a single day within the period.
TotalPeriodTimeDuration	String		The total time duration recorded across the entire time card period. This value reflects the cumulative worked or payable time for the associate.
HomeLaborAllocations	String		The home labor allocation details that are associated with the time card. These details indicate the cost center or department where the associate's time is charged.
Actions	String		The actions that are available for the time card record (for example, Edit, Submit, or Approve). These actions define the workflow options for managing the time card in ADP.

TimeCardsAllActiveWorkers

The view that returns time card data for all active workers in the organization. It consolidates current worker time records to provide a comprehensive overview of attendance and worked hours across departments.

Columns


Name	Type	References	Description
AssociateOID [KEY]	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate within the ADP system. This Id links time card entries to the correct worker profile across HR and payroll records.
WorkerID [KEY]	String		The unique Id that represents the worker to whom the time card belongs. This Id ensures that time tracking aligns with the employee's assignment and payroll data.
TimeCardID [KEY]	String		The unique Id for the time card record. This Id differentiates one time card submission from another for audit and reporting purposes.
PersonLegalName	String		The worker's full legal name as maintained in the core Human Resources (HR) system. This value is used for display and verification on payroll and compliance documents.
PersonLegalFamilyName1	String		The worker's primary family name that is recorded in the legal documentation. This family name provides a consistent basis for employee identification in reports.
PersonLegalFormattedName	String		The formatted version of the worker's legal name that is displayed in official reports and user interfaces. This version of the name follows the organization's preferred naming conventions.
ProcessingStatusCodeValue	String		The code value that indicates the current processing status of the time card (for example, 'Pending', 'Approved', or 'Processed').
ProcessingStatusCodeShortName	String		The short name that corresponds to the value for the processing status code. This name provides a simplified label for display within reports or dashboards.
periodCodeValue	String		The code value that represents the payroll or time card period. Supported values include current, next, previous, and so on. The code value determines which pay cycle the record belongs to.
periodCodeShortName	String		The short name for the payroll or time card period code. This name is used for quick reference in user interfaces and reporting tools.
periodCodeLongName	String		The long name for the payroll or time card period code. This name provides a detailed, descriptive label that helps users interpret period-based data.
TimePeriodStartDate	String		The start date of the time card period. This date defines the first day of the payroll or reporting timeframe captured in this record.
TimePeriodEndDate	String		The end date of the time card period. This date defines the last day of the payroll or reporting timeframe associated with this record.
TimePeriodPeriodStatus	String		The current status of the time period (for example, Open, Closed, or Locked). This status determines whether time entries for that period can be modified.
PositionID	String		The unique Id that represents the worker's position or job role within the organization. This Id allows linkage between time worked and labor costing or departmental budgeting.
ExceptionCounts	String		The collection of exception counts that summarize issues that are detected in the time card (for example, missed punches or overtime violations). This field supports payroll validation and compliance reviews.
PeriodTotals	String		The aggregated totals for the entire time card period, including total hours worked, leave, and overtime. This aggregation provides a summarized view for payroll calculation.
DailyTotals	String		The daily totals of hours and related time data within the period. This field enables managers to review work distribution and detect anomalies in attendance.
TotalPeriodTimeDuration	String		The total time duration that is recorded across the entire time period. This field includes all payable and non-payable time and is used for labor and cost reporting.
HomeLaborAllocations	String		The set of labor allocation records that associate worked hours with cost centers or departments. This field ensures proper labor costing within financial and HR systems.
Actions	String		The available system or user actions that are associated with the time card record, (for example, submit, approve, or reject). These actions define workflow options and state transitions.

TimeCardsDailyTotals

The view that returns daily time card totals for individual workers. This view summarizes hours worked each day by category (for example, Regular, Overtime, or Leave) to support payroll review and reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.

SELECT * FROM TimeCardsDailyTotals WHERE AssociateOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate within the ADP system. This Id links daily time totals to the correct worker record across Human Resources (HR) and payroll processes.
WorkerID	String		The Id that identifies the specific worker associated with the time card. This field ensures that each daily total is attributed to the correct employee for labor costing and payroll accuracy.
TimeCardID	String		The Id for the time card record that the daily totals belong to. This Id is used to connect individual day entries with the overall time card summary for a given pay period.
EntryDate	Date		The specific calendar date for which the time is recorded. This field defines the day of work within the time period and is used for scheduling, payroll, and compliance tracking.
PayCodeCodeValue	String		The code value that represents the type of pay that is applied to the recorded time (for example, Regular, Overtime, or Holiday). This field determines how hours are categorized for payroll calculation.
PayCodeShortName	String		The short, human-readable name for the pay code value. This field provides a simplified label for quick reference in reports and user interfaces.
RateBaseMultiplierValue	String		The multiplier value that is applied to the base pay rate to calculate adjusted pay. This field supports complex pay structures such as shift differentials or overtime premiums.
RateAmountValue	Double		The numeric pay rate that is applied to the recorded hours for the day. This value is used by payroll systems to determine gross earnings.
RateCurrencyCode	String		The three-letter ISO currency code that identifies the currency in which the pay rate is denominated (for example, USD or CAD). This field ensures accurate monetary conversion and reporting.
TimeDuration	String		The total duration of time that is recorded for the day. This field includes all payable and non-payable hours and provides visibility into total hours worked or charged.
periodCodeValue	String		The code value that represents the payroll or reporting period. Supported values include current, next, previous, and so on. This field determines which payroll cycle the daily total belongs to.
TimePeriodStartDate	String		The start date of the time period that the daily total falls within. This field defines the beginning of the reporting or payroll cycle.
TimePeriodEndDate	String		The end date of the time period that the daily total falls within. This field defines the closing date of the reporting or payroll cycle and is used to calculate period totals.

TimeCardsPeriodTotals

The view that returns total hours and earnings that are aggregated over an entire payroll period for each worker. This view provides summarized data that is used for payroll calculation and compliance tracking.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.

SELECT * FROM TimeCardsPeriodTotals WHERE AssociateOID = 'G3349PZGBADQY8H7'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate within the ADP system. This Id connects period-level totals to the correct worker record across Human Resources (HR) and payroll systems.
WorkerID	String		The Id that identifies the worker to whom the time card belongs. This field ensures accurate linkage between time worked and the corresponding employee for payroll processing.
TimeCardID	String		The Id for the time card record that the period totals summarize. This field enables the aggregation of daily totals into a single view for a defined time period.
payCodecodeValue	String		The code value that represents the pay category applied to the time total (for example, Regular, Overtime, or Holiday). This field defines how hours are classified for payroll calculation.
payCodeshortName	String		The short name for the pay code that corresponds to the pay category value. This field provides a readable label that is displayed in reports and dashboards.
RateBaseMultiplierValue	String		The multiplier value that is applied to the base rate to calculate adjusted pay. This field supports pay differentials and other rate-based adjustments.
RateAmountValue	Double		The pay rate that is applied to the time period's recorded hours. This field provides the numeric basis for gross pay calculation and audit reporting.
RateCurrencyCode	String		The three-letter ISO currency code that identifies the currency of the pay rate (for example, USD or CAD). This field ensures consistency in payroll and accounting reports.
TimeDuration	String		The total duration of hours recorded for the pay period. This field includes both payable and non-payable time and is used for labor distribution and payroll validation.
periodCodeValue	String		The code value that identifies the payroll or reporting period. Supported values include Current, Next, or Previous. This field determines which cycle the period totals belong to.
TimePeriodStartDate	String		The start date of the reporting or payroll period. This field defines when the time period begins for calculation and reporting purposes.
TimePeriodEndDate	String		The end date of the reporting or payroll period. This field defines when the time period closes and marks the end of the payroll cycle for reconciliation and review.

WageLawCoverageCode

The view that returns standardized wage-law coverage codes that are applied to worker records. This view identifies the regulatory wage-coverage classification for each position or location, supporting compliance with local and federal labor laws.

Columns


Name	Type	References	Description
CodeValue	String		The unique code value that represents a specific wage-law coverage type. This field identifies the regulation or statutory category that is applied to a worker's pay or position (for example, FLSA Exempt, Non-Exempt, and so on).
ShortName	String		The abbreviated name that corresponds to the wage-law coverage code. This field provides a concise label that is displayed in payroll and compliance reports for quick reference.

WorkAssignmentCustomHistoryCustomGroupAmountFields

The view that returns historical data for custom amount fields that are defined within work-assignment custom groups. This view tracks numeric compensation or allocation values that are associated with each work assignment.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupAmountFields WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
AmountValue	Integer		The numeric amount that represents the recorded value for the custom history group field. This field is used to capture a measurable figure, such as wages, bonuses, or adjustments that are associated with a worker's historical assignment data.
CategoryCodeCodeValue	String		The code value that identifies the category assigned to this amount field. This field classifies the amount type for reporting or analytics (for example, Base Pay, Commission, Adjustment, and so on).
CategoryCodeLongName	String		The full descriptive name of the category code value. This field provides clarity in reports and dashboards by displaying the complete name instead of a coded reference.
CategoryCodeShortName	String		The abbreviated name that corresponds to the category code. This field provides a concise label that is used in screens, exports, and quick summaries.
CurrencyCode	String		The three-letter ISO currency code that specifies the currency of the amount value (for example, USD, CAD, or EUR). This field ensures that the monetary value is correctly interpreted in multi-currency reporting environments.
ItemID	String		The unique identifier (Id) that represents the specific item or entry within the custom history group. This Id is used to differentiate and track individual custom amount records across worker assignments.
NameCodeCodeValue	String		The code value that identifies the type or name of the custom field recorded in this group. This field defines what the amount represents within the context of the worker's history.
NameCodeLongName	String		The full name of the code that describes the custom field name. This field provides a clear, human-readable label for data presentation and auditing.
NameCodeShortName	String		The short name for the code value that identifies the custom field. This field allows for concise display in user interfaces and report headers.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom the historical group amount record belongs. This field links the data to the correct worker profile in Human Resources (HR) and payroll systems.

WorkAssignmentCustomHistoryCustomGroupCodeFields

The view that returns historical data for code-based fields defined in work-assignment custom groups. This view includes classification or lookup values that are used to categorize historical work-assignment information.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupCodeFields WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
CategoryCodeCodeValue	String		The code value that identifies the category associated with this custom group field. This field classifies the record within a broader reporting or configuration category (for example, Earnings, Deductions, Adjustments, and so on).
CategoryCodeLongName	String		The full descriptive name of the category code value. This field provides a complete, human-readable description for reporting and auditing purposes.
CategoryCodeShortName	String		The short or abbreviated name that corresponds to the category code. This field provides a simplified reference for use in dashboards or user interfaces.
CodeValue	String		The unique code value that defines the specific custom-group code field. This field identifies the data element used to categorize or tag the worker's historical assignment record.
ItemID	String		The unique identifier (Id) that represents the individual custom-group code entry. This Id enables the tracking of changes or additions within the worker's custom history data set.
LongName	String		The full descriptive name that corresponds to the code value. This field is used for reporting and provides a clear understanding of the code's meaning.
NameCodeCodeValue	String		The code value that identifies the name of the custom field that is being tracked in the historical group. This field defines what the code represents in relation to the worker's assignment history.
NameCodeLongName	String		The full name of the code that describes the custom field name. This field provides a user-friendly label that is used in exports, reports, and data validation.
NameCodeShortName	String		The abbreviated name that corresponds to the name code. This field provides a short label for use in compact layouts, dashboards, or summaries.
ShortName	String		The concise display name that corresponds to the long name. This field ensures that a shorter label is available for quick visual reference while preserving consistency with the long name.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom the custom group code record belongs. This field links the historical entry to the correct worker profile within Human Resources (HR) and payroll systems.

WorkAssignmentCustomHistoryCustomGroupDateFields

The view that returns historical data for date fields that are defined within work-assignment custom groups. This view is used to track important milestone or effective dates for assignment changes and employment events.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupDateFields WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
CategoryCodeCodeValue	String		The code value that identifies the category associated with this custom-group field. This field classifies the record by business or payroll category (for example, Benefits, Compensation, or Scheduling, and so on).
CategoryCodeLongName	String		The full descriptive name of the category code value. This field provides a complete label for display in reports and analytics that use custom date-based records.
CategoryCodeShortName	String		The short or abbreviated name that corresponds to the category code. This field provides a simplified label for dashboards and data exports.
DateValue	Date		The calendar date that is recorded for the custom history-group field. This field represents a significant date related to the worker's assignment (for example, a certification date, eligibility start date, or custom milestone date, and so on).
ItemID	String		The unique identifier (Id) that represents the specific custom-group date entry. This Id is used to track and reference individual date-based records within a worker's assignment history.
NameCodeCodeValue	String		The code value that identifies the name of the custom field that is being recorded as part of this historical group. This field defines the purpose of the date value in the worker's record.
NameCodeLongName	String		The full name of the code that describes the custom field name. This field provides a clear, user-friendly description for reports and HR review.
NameCodeShortName	String		The abbreviated name that corresponds to the name code. This field provides a short, recognizable label for use in reports and dashboards.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this custom-group date record belongs. This field links the historical entry to the correct worker profile within Human Resources (HR) and payroll systems.

WorkAssignmentCustomHistoryCustomGroupDateTimeFields

The view that returns historical data for date-time fields that are defined in work-assignment custom groups. This view captures both date and timestamp information for work-assignment changes and related Human Resources (HR) events.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupDateTimeFields WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
CategoryCodeCodeValue	String		The code value that identifies the category associated with this custom-group field. This field classifies the date and time record by business or payroll category (for example, Attendance, Scheduling, Compliance, and so on).
CategoryCodeLongName	String		The full descriptive name of the category code value. This field provides the complete label that appears in reports and analytics for date and time records.
CategoryCodeShortName	String		The short or abbreviated name that corresponds to the category code. This field provides a simplified label that is used in dashboards, exports, and compact layouts.
DateTimeValue	Datetime		The date and time value that represents a specific moment recorded within the custom history group. This field captures precise timestamps for events related to a worker's assignment (for example, clock-in time, approval timestamp, or policy activation date).
ItemID	String		The unique identifier (Id) that represents the specific custom-group datetime entry. This Id is used to differentiate and track individual timestamped records within a worker's historical assignment data.
NameCodeCodeValue	String		The code value that identifies the name of the custom field that is being tracked in this group. This field defines the purpose or type of datetime information recorded in the worker's history.
NameCodeLongName	String		The full name of the code that describes the custom field name. This field provides a complete, human-readable description for reporting and audit review.
NameCodeShortName	String		The abbreviated name that corresponds to the name code. This field provides a short reference label for use in summaries, dashboards, and reports.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this custom-group datetime record belongs. This field links the timestamped entry to the correct worker profile within HR and payroll systems.

WorkAssignmentCustomHistoryCustomGroupIndicatorFields

The view that returns historical data for indicator fields within work-assignment custom groups. This view stores Boolean or flag-based information that identifies specific employment conditions or attributes.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupIndicatorFields WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
CategoryCodeCodeValue	String		The code value that identifies the category associated with this custom-group field. This field classifies the indicator record according to a defined business or payroll category (for example, Compliance, Eligibility, or Benefits).
CategoryCodeLongName	String		The full descriptive name of the category code value. This field provides the complete name that is displayed in reports and analytics related to custom indicator data.
CategoryCodeShortName	String		The abbreviated name that corresponds to the category code. This field provides a concise label that is used for compact layouts, dashboards, and exports.
IndicatorValue	Boolean		The Boolean value that indicates whether a specific condition or attribute applies to the worker's assignment. This field is used to capture true or false responses (for example, Active = True or Eligible = False) for compliance or policy tracking.
ItemID	String		The unique identifier (Id) that represents the specific custom-group indicator entry. This Id is used to track and reference individual Boolean records within a worker's custom history data.
NameCodeCodeValue	String		The code value that identifies the name of the custom field that is being tracked within this historical group. This field defines the meaning or purpose of the indicator value for the worker's record.
NameCodeLongName	String		The full name of the code that describes the custom field name. This field provides a clear, descriptive label that is used for reporting, auditing, and HR analysis.
NameCodeShortName	String		The abbreviated name that corresponds to the name code. This field provides a short, human-readable label for quick reference in dashboards or compact reports.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this custom-group indicator record belongs. This field links the Boolean entry to the correct worker profile within Human Resources (HR) and payroll systems.

WorkAssignmentCustomHistoryCustomGroupLinks

The view that returns link field data for work-assignment custom groups. This view maintains relationships between custom fields and other reference entities, allowing traceability of historical assignment data.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupLinks WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
EncType	String		The encoding type that is used when submitting the link request. This field specifies how the payload data is formatted when it is sent to or received from an external system (for example, application/json, multipart/form-data, and so on).
Href	String		The hyperlink reference (URL) that defines the endpoint for the custom-group link. This field directs integrations or applications to the related resource or service.
MediaType	String		The media type of the resource that the link points to. This field specifies the format of the content that is exchanged (for example, text/html, application/xml, and so on).
Method	String		The HTTP method that is used to interact with the linked resource (for example, GET, POST, PUT, DELETE, and so on). This field defines the operation type that is permitted for the link.
PayLoadArguments	String		The list of arguments or parameters that are passed in the request payload when the link is invoked. This field defines the required input values for API or workflow calls.
Rel	String		The relationship value that describes how the linked resource relates to the current record. This field helps define navigation, dependencies, or hierarchical relationships among linked objects.
Schema	String		The schema definition that describes the data structure of the linked resource. This field ensures that data exchanged with external systems follows a consistent format.
TargetSchema	String		The schema definition that describes the expected structure of the target resource. This field is used to validate and interpret responses when interacting with external or internal services.
Title	String		The descriptive title or label that identifies the purpose of the link. This field provides a readable name that is displayed in user interfaces or integration logs.
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate connected to this custom-group link. This Id ties the link resource to the correct worker profile within Human Resources (HR) and related systems.

WorkAssignmentCustomHistoryCustomGroupNumberFields

The view that returns historical data for numeric fields that are defined within work-assignment custom groups. This view tracks quantitative metrics (for example, hours, rates, or counts) that are related to historical work assignments.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupNumberFields WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
CategoryCodeCodeValue	String		The code value that identifies the category associated with this custom-group field. This field classifies the numerical record according to a defined business or payroll category (for example, Compensation, Benefits, or Performance).
CategoryCodeLongName	String		The full descriptive name of the category code value. This field provides the complete label that is displayed in HR reports and analytics for number-based records.
CategoryCodeShortName	String		The abbreviated name that corresponds to the category code. This field provides a concise label for dashboards, data exports, and compact layouts.
ItemID	String		The unique identifier (Id) that represents the individual custom-group numeric entry. This Id enables tracking of numeric data within a worker's custom history set.
NameCodeCodeValue	String		The code value that identifies the name of the custom field that is associated with the recorded number. This field defines what the number represents in relation to the worker's assignment history.
NameCodeLongName	String		The full name of the code that describes the custom field name. This field provides a clear, descriptive label for reporting, auditing, and validation.
NameCodeShortName	String		The abbreviated name that corresponds to the name code. This field provides a shortened label that is used in dashboards and data summaries.
NumberValue	Integer		The numeric value that is recorded for the custom history-group field. This field captures measurable quantities or metrics that apply to a worker's assignment (for example, quota, rating, or threshold).
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this custom-group number record belongs. This field links the numeric entry to the correct worker profile within Human Resources (HR) and payroll systems.

WorkAssignmentCustomHistoryCustomGroupPercentFields

The view that returns historical data for percent fields that are defined within work-assignment custom groups. This view captures percentage-based metrics such as allocation ratios or contribution percentages that are tied to historical assignments.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupPercentFields WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
CategoryCodeCodeValue	String		The code value that identifies the category associated with this custom-group field. This field classifies the percentage record by its business or payroll category (for example, Tax Withholding, Commission Rate, or Deduction Percentage).
CategoryCodeLongName	String		The full descriptive name of the category code value. This field provides the complete label that is used in reports and dashboards for percentage-based historical records.
CategoryCodeShortName	String		The abbreviated name that corresponds to the category code. This field provides a short label that is displayed in tables, exports, and summary views.
ItemID	String		The unique identifier (Id) that represents the specific custom-group percentage entry. This Id enables tracking of individual percentage records within a worker's historical data set.
NameCodeCodeValue	String		The code value that identifies the name of the custom field recorded in this group. This field defines what the percentage represents within the worker's assignment history.
NameCodeLongName	String		The full name of the code that describes the custom field name. This field provides a clear, human-readable label for display in Human Resources (HR) and payroll reports.
NameCodeShortName	String		The abbreviated name that corresponds to the name code. This field provides a concise label that is used for quick identification in dashboards and reporting tools.
PercentValue	Integer		The numeric percentage value that is recorded for the custom history-group field. This field captures ratios or rates that are associated with a worker's assignment (for example, commission percentage, employer match rate, or contribution rate).
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this custom-group percentage record belongs. This field links the percentage entry to the correct worker profile within HR and payroll systems.

WorkAssignmentCustomHistoryCustomGroupStringFields

The view that returns historical data for text-based fields that are defined within work-assignment custom groups. This view captures descriptive or narrative information stored in historical records.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupStringFields WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
CategoryCodeCodeValue	String		The code value that identifies the category associated with this custom-group field. This field classifies the string record by business or payroll category (for example, Job Classification, Department, or Work Location).
CategoryCodeLongName	String		The full descriptive name of the category code value. This field provides the complete label that is used in Human Resources (HR) reports and data analytics for string-based historical records.
CategoryCodeShortName	String		The abbreviated name that corresponds to the category code. This field provides a concise label that is displayed in dashboards, exports, and summary layouts.
ItemID	String		The unique identifier (Id) that represents the individual custom-group string entry. This Id enables tracking of textual data that is stored in the worker's assignment history.
NameCodeCodeValue	String		The code value that identifies the name of the custom field recorded in this group. This field defines the specific textual attribute being tracked within the worker's historical data.
NameCodeLongName	String		The full name of the code that describes the custom field name. This field provides a user-friendly label that is displayed in reports and data exports.
NameCodeShortName	String		The abbreviated name that corresponds to the name code. This field provides a short, recognizable label for use in dashboards and quick-reference tables.
StringValue	String		The text value that is recorded for the custom history-group field. This field captures descriptive or categorical data that is associated with a worker's assignment (for example, Project Name, Certification Type, or Work Status).
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this custom-group string record belongs. This field links the text entry to the correct worker profile within HR and payroll systems.

WorkAssignmentCustomHistoryCustomGroupTelephoneFields

The view that returns historical data for telephone fields that are defined within work-assignment custom groups. This view captures contact numbers or communication Ids that are linked to historical assignments.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentCustomHistoryCustomGroupTelephoneFields WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
Access	String		The access code or prefix that is used to initiate the telephone call. This field defines the dialing sequence that is required before the main number (for example, 9 for an outside line).
AreaDialing	String		The area dialing code that identifies the regional telephone area. This field is used to route calls correctly within a country or region (for example, 212 for New York or 213 for Los Angeles).
CategoryCodeCodeValue	String		The code value that identifies the category that is associated with this custom-group field. This field classifies the telephone record by business or payroll category (for example, Work Contact, Personal Contact, or Emergency Contact).
CategoryCodeLongName	String		The full descriptive name of the category code value. This field provides the complete label that appears in Human Resources (HR) reports and employee contact records.
CategoryCodeShortName	String		The abbreviated name that corresponds to the category code. This field provides a short label that is used in dashboards, exports, and summaries.
CountryDialing	String		The international country dialing code that is used to identify the country of the telephone number (for example, 1 for the United States or 44 for the United Kingdom).
DialNumber	String		The full telephone number that is dialed after the access, area, and country codes. This field represents the core contact number that is stored in the worker's record.
Extension	String		The internal extension number that routes the call to a specific department or individual within an organization. This field is often used for corporate or departmental phone systems.
FormattedNumber	String		The fully formatted version of the telephone number that includes access, area, country, and extension information. This field presents the number in a readable format for reports and user interfaces.
ItemID	String		The unique identifier (Id) that represents the specific custom-group telephone entry. This Id allows systems to track and manage phone records across a worker's historical assignment data.
NameCodeCodeValue	String		The code value that identifies the name of the custom field that is being tracked within this group. This field defines the purpose or usage context of the telephone number.
NameCodeLongName	String		The full name of the code that describes the custom field name. This field provides a clear, descriptive label for reports, exports, and HR record reviews.
NameCodeShortName	String		The abbreviated name that corresponds to the name code. This field provides a short, recognizable label for quick reference in dashboards and data tables.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this custom-group telephone record belongs. This field links the contact information to the correct worker profile within HR and payroll systems.

WorkAssignmentHistory

The view that returns the full historical record of work assignments for each associate. It tracks changes in position, department, or reporting structure over time. This view supports compliance, analytics, and employment verification.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistory WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
PrimaryIndicator	Boolean		The Boolean value that indicates whether this work assignment record represents the worker's primary assignment. This field is used to distinguish the main employment relationship from secondary or concurrent assignments.
OfferExtensionDate	Date		The date on which an offer of employment or assignment was extended to the worker. This field is used for recruiting, onboarding, and compliance tracking.
OfferAcceptanceDate	Date		The date on which the worker accepted the employment or assignment offer. This field helps determine offer-to-hire timelines and onboarding efficiency metrics.
HireDate	Date		The official date on which the worker was hired. This field marks the beginning of the worker's employment relationship for Human Resources (HR) and payroll purposes.
SeniorityDate	Date		The date that is used to calculate the worker's seniority within the organization. This field determines tenure-based benefits, accruals, and eligibility thresholds.
ExpectedStartDate	Date		The date on which the worker was originally expected to begin the assignment. This field supports workforce planning and onboarding schedule tracking.
ActualStartDate	Date		The date on which the worker actually began the assignment. This field can differ from the expected start date and is used for accurate payroll, benefits, and compliance reporting.
TerminationDate	Date		The date on which the worker's employment or assignment ended. This field is used to determine final pay, benefits termination, and workforce status reporting.
AssignmentStatusCode	String		The code that identifies the current status of the work assignment record. This field links to standardized status definitions that govern employment state tracking.
AssignmentStatusCodeValue	String		The value that is associated with the assignment status code. This field provides the machine-readable representation that is used for data integration and workflow automation.
AssignmentStatusLongName	String		The full descriptive name of the assignment status. This field provides a clear label for HR and management reporting (for example, Active, On Leave, or Terminated).
AssignmentStatusreasonCodeValue	String		The code value that identifies the reason associated with the current assignment status. This field provides a standardized classification for status changes.
AssignmentStatusreasonCodeShortName	String		The abbreviated name that corresponds to the assignment-status reason code. This field provides a concise label for dashboards and compact reports.
AssignmentStatusreasonCodeLongName	String		The full descriptive name of the assignment-status reason code. This field provides the complete label for HR and audit reports.
AssignmentStatusEffectiveDate	Date		The effective date of the current assignment status. This field determines when the status change became active for payroll and employment records.
WorkerTypeCodeValue	String		The code value that identifies the worker type associated with this assignment (for example, Employee, Contractor, or Intern). This field supports labor classification and reporting.
WorkerTypeShortName	String		The abbreviated name that corresponds to the worker type code. This field provides a short label for quick display in reports and dashboards.
WorkerTypeLongName	String		The full descriptive name of the worker type code. This field provides a clear definition for reporting and workforce segmentation.
AssignmentTermCodeValue	String		The code value that identifies the term or duration of the worker's assignment (for example, Permanent, Temporary, or Fixed-Term). This field supports compliance and workforce planning analysis.
AssignmentTermCodeShortName	String		The abbreviated name that corresponds to the assignment term code. This field provides a compact label for reporting layouts and dashboard displays.
AssignmentTermCodeLongName	String		The full descriptive name of the assignment term code. This field provides a clear explanation of the assignment type for HR and management use.
WorkLevelCodeValue	String		The code value that identifies the work level or grade associated with the assignment (for example, Entry-Level, Manager, or Executive). This field supports organizational hierarchy tracking and compensation analysis.
WorkLevelCodeShortName	String		The abbreviated name that corresponds to the work level code. This field provides a short label used in dashboards and compact tables.
WorkLevelCodeLongName	String		The full descriptive name of the work level code. This field provides the complete label that appears in HR reports and job classification documents.
NationalityContextCodeValue	String		The code value that identifies the nationality context associated with the assignment. This field defines how nationality-specific policies or compliance rules are applied.
NationalityContextCodeShortName	String		The abbreviated name that corresponds to the nationality context code. This field provides a short label that is used in dashboards and internal reports.
NationalityContextCodeLongName	String		The full descriptive name of the nationality context code. This field provides the complete name that is displayed in HR reports and compliance summaries.
VipIndicator	Boolean		The Boolean value that indicates whether the worker is classified as a VIP. This field is used to flag high-profile or confidential employees within HR and payroll systems.
VipTypeCodeValue	String		The code value that identifies the type of VIP classification (for example, Executive Leadership, Key Contributor, or Confidential Employee). This field defines the VIP group or classification assigned to the worker.
VipTypeCodeShortName	String		The abbreviated name that corresponds to the VIP type code. This field provides a short label for reports and quick reference views.
VipTypeCodeLongName	String		The full descriptive name of the VIP type code. This field provides the complete label that appears in HR reports and analytics dashboards.
ExecutiveIndicator	Boolean		The Boolean value that indicates whether the worker holds an executive position. This field is used for organizational hierarchy reporting and compliance disclosure tracking.
ExecutiveTypeCodeValue	String		The code value that identifies the type of executive classification (for example, Senior Executive, Vice President, or Director). This field defines the executive role assigned to the worker.
ExecutiveTypeCodeShortName	String		The abbreviated name that corresponds to the executive type code. This field provides a concise label for use in dashboards and internal listings.
ExecutiveTypeCodeLongName	String		The full descriptive name of the executive type code. This field provides a complete label that appears in HR reports and workforce analytics.
OfficerIndicator	Boolean		The Boolean value that indicates whether the worker serves as an officer within the organization. This field is used for corporate governance, legal reporting, and regulatory compliance tracking.
OfficerTypeCodeValue	String		The code value that identifies the type of officer role assigned to the worker (for example, Chief Executive Officer, Chief Financial Officer, or Corporate Secretary). This field defines the officer designation within the organizational structure.
OfficerTypeCodeShortName	String		The abbreviated name that corresponds to the officer type code. This field provides a concise label for dashboards, organization charts, and summary tables.
OfficerTypeCodeLongName	String		The full descriptive name of the officer type code. This field provides the complete label that identifies the officer's role within the organization (for example, Chief Executive Officer, Chief Financial Officer).
ManagementPositionIndicator	Boolean		The Boolean value that indicates whether the worker holds a management position. This field is used to identify supervisory roles for reporting, compliance, and organizational hierarchy analysis.
LegalEntityID	String		The unique identifier (Id) that represents the legal entity associated with this work assignment. This Id ensures accurate linkage between employment records, tax reporting, and corporate entities.
HighlyCompensatedIndicator	Boolean		The Boolean value that indicates whether the worker is classified as highly compensated. This field supports compliance reporting and regulatory tracking for payroll and benefits eligibility.
HighlyCompensatedTypeCodeValue	String		The code value that identifies the type of highly compensated classification that is assigned to the worker (for example, Officer, Director, or Key Employee). This field defines the specific compensation category used for reporting.
HighlyCompensatedTypeCodeShortName	String		The abbreviated name that corresponds to the highly compensated type code. This field provides a concise label for reports and dashboards.
HighlyCompensatedTypeCodeLongName	String		The full descriptive name of the highly compensated type code. This field provides a complete label for HR and compliance reporting.
StockOwnerIndicator	Boolean		The Boolean value that indicates whether the worker holds stock in the organization. This field supports equity management and regulatory disclosure reporting.
StockOwnerPercentage	Double		The percentage of ownership that represents the portion of company stock held by the worker. This field provides an exact value for equity and compliance calculations.
JobCodeValue	String		The code value that identifies the worker's job classification or role. This field defines the specific job position within the organization's job catalog or hierarchy.
JobCodeShortName	String		The abbreviated name that corresponds to the job code. This field provides a short, recognizable label for use in dashboards and reports.
JobCodeLongName	String		The full descriptive name of the job code. This field provides the complete label used in HR reports, job catalogs, and compliance documents.
JobTitle	String		The official title of the worker's position. This field displays the title as recognized by the organization and is used in internal systems, communications, and reports.
WageLawCoverageCodeValue	String		The code value that identifies the wage-law coverage category that applies to this worker. This field ensures that payroll calculations comply with relevant wage laws (for example, FLSA Exempt, Non-Exempt).
WageLawCoverageCodeShortName	String		The abbreviated name that corresponds to the wage-law coverage code. This field provides a short label for quick reference in HR and payroll systems.
WageLawCoverageCodeLongName	String		The full descriptive name of the wage-law coverage code. This field provides a clear label that is displayed in reports and compliance documentation.
WageLawCoverageLawNameCodeValue	String		The code value that identifies the specific law or regulation governing wage coverage. This field links wage-law coverage to applicable legal frameworks or policies.
WageLawCoverageLawNameCodeShortName	String		The abbreviated name that corresponds to the wage-law name code. This field provides a compact label used in compliance dashboards and HR reports.
WageLawCoverageLawNameCodeLongName	String		The full descriptive name of the wage-law name code. This field provides a clear and complete label used in payroll compliance reporting.
PositionID	String		The unique Id that represents the position associated with the worker's assignment. This Id links the assignment to the organization's job structure for workforce planning and analytics.
PositionTitle	String		The official title of the position that corresponds to the assignment. This field provides the role name as defined within the organizational structure.
LaborUnionCodeValue	String		The code value that identifies the labor union associated with the worker. This field supports collective bargaining and labor relations reporting.
LaborUnionshortName	String		The abbreviated name that corresponds to the labor-union code. This field provides a short label for reports and HR dashboards.
LaborUnionlongName	String		The full descriptive name of the labor-union code. This field provides the complete label used in HR and compliance reports.
LaborUnionSeniorityDate	Date		The date that represents the worker's seniority within the labor union. This field is used to determine eligibility for benefits, bidding rights, and other union-related provisions.
BargainingUnitCodeValue	String		The code value that identifies the bargaining unit to which the worker belongs. This field supports collective bargaining agreement administration and compliance tracking.
BargainingUnitshortName	String		The abbreviated name that corresponds to the bargaining-unit code. This field provides a concise label for use in reports and dashboards.
BargainingUnitlongName	String		The full descriptive name of the bargaining-unit code. This field provides the complete label used in HR, legal, and compliance reports.
BargainingUnitSeniorityDate	Date		The date that represents the worker's seniority within the bargaining unit. This field is used to determine eligibility for union-based benefits, promotions, and priority assignments.
WorkShiftCodeValue	String		The code value that identifies the worker's designated work shift (for example, Day, Night, or Rotating). This field supports scheduling, labor costing, and workforce planning.
WorkShiftCodeshortName	String		The abbreviated name that corresponds to the work-shift code. This field provides a short label for reports and workforce scheduling dashboards.
WorkShiftCodelongName	String		The full descriptive name of the work-shift code. This field provides a complete label that appears in HR reports and scheduling documentation.
WorkArrangementCodeValue	String		The code value that identifies the worker's arrangement or work mode (for example, On-Site, Remote, or Hybrid). This field is used for policy enforcement and workplace flexibility reporting.
WorkArrangementCodeshortName	String		The abbreviated name that corresponds to the work-arrangement code. This field provides a short label for quick reference in HR systems and dashboards.
WorkArrangementCodelongName	String		The full descriptive name of the work-arrangement code. This field provides a complete label used in workforce strategy and compliance reports.
StandardHoursQuality	String		The description or classification that indicates the quality type associated with the standard-hours configuration. This field defines how standard work hours are measured or categorized within the assignment record.
StandardHoursCodeValue	Integer		The code value that identifies the standard number of hours for the worker's assignment (for example, 40 for full-time, 20 for part-time). This field is used in payroll calculations and labor distribution reporting.
StandardHoursCodeshortName	String		The abbreviated name that corresponds to the standard-hours code. This field provides a short label for dashboards and time reporting summaries.
StandardHoursCodelongName	String		The full descriptive name of the standard-hours code. This field provides the complete label that appears in HR reports and configuration documentation.
FullTimeEquivalenceRatio	Integer		The numeric value that represents the worker's full-time equivalence ratio. This field is used to calculate benefit eligibility, headcount metrics, and workload analysis.
HomeWorkLocationCodeValue	String		The code value that identifies the worker's home-work location. This field specifies the primary work site that is assigned to the employee (for example, Corporate Office, Remote, or Regional Hub).
HomeWorkLocationCodeshortName	String		The abbreviated name that corresponds to the home-work-location code. This field provides a short label used in dashboards and workforce reports.
HomeWorkLocationCodelongName	String		The full descriptive name of the home-work-location code. This field provides the complete label used in HR reports and organizational charts.
HomeWorkLocationAddressScriptCodeValue	String		The code value that identifies the address script or formatting type used for the home-work location. This field ensures that address formatting aligns with regional or country-specific standards.
HomeWorkLocationAddressScriptCodeshortName	String		The abbreviated name that corresponds to the address script code. This field provides a short label that is used in system configurations and address templates.
HomeWorkLocationAddressScriptCodelongName	String		The full descriptive name of the address script code. This field provides the complete label displayed in configuration and address management tools.
HomeWorkLocationAddresslineFour	String		The fourth line of the home-work location address. This field stores additional address information that is used for extended location details or delivery routing.
HomeWorkLocationAddresslineFive	String		The fifth line of the home-work-location address. This field allows for the inclusion of supplemental address information that supports complex address formats.
HomeWorkLocationAddressbuildingNumber	String		The building number that identifies the specific structure at the work location. This field is used for mail delivery and physical site identification.
HomeWorkLocationAddressbuildingName	String		The name of the building associated with the work location. This field provides a descriptive Id for the facility in HR and facilities management systems.
HomeWorkLocationAddressblockName	String		The name of the block, district, or area in which the building is located. This field supports more detailed geographic identification for reporting and logistics.
HomeWorkLocationAddressstreetName	String		The name of the street where the work location is situated. This field provides the primary street Id used in mapping, reporting, and correspondence.
HomeWorkLocationAddressstreetTypeCodeValue	String		The code value that identifies the type of street (for example, Avenue, Road, or Boulevard). This field ensures consistent classification of address components.
HomeWorkLocationAddressstreetTypeCodeshortName	String		The abbreviated name that corresponds to the street type code. This field provides a compact label for display in reports and address summaries.
HomeWorkLocationAddressstreetTypeCodelongName	String		The full descriptive name of the street type code. This field provides the complete label that appears in HR reports and address records.
HomeWorkLocationAddressunit	String		The unit number or Id within the building. This field identifies a specific office, suite, or apartment as part of the full address.
HomeWorkLocationAddressfloor	String		The floor number or designation for the work location. This field specifies where the employee's work area is located within the building.
HomeWorkLocationAddressstairCase	String		The stairwell or section Id within a multi-unit building. This field supports internal location mapping and emergency response records.
HomeWorkLocationAddressdoor	String		The door or room Id for the work location. This field provides additional detail for internal navigation or facility management.
HomeWorkLocationAddresspostOfficeBox	String		The post office (PO) box number that is used for mail delivery. This field is populated when the work location uses a PO Box instead of a street address.
HomeWorkLocationAddressdeliveryPoint	String		The designated delivery point or code for mail routing. This field is used to optimize postal delivery and logistics for the work location.
HomeWorkLocationAddressplotID	String		The unique plot or parcel Id that is assigned to the physical property. This field is used for mapping, land use, or facility reference purposes.
HomeWorkLocationAddresscountrySubdivisionLevel2Value	String		The code value that identifies the second-level country subdivision (for example, County, District, or Municipality). This field supports detailed geographic reporting.
HomeWorkLocationAddresscountrySubdivisionLevel2shortName	String		The abbreviated name that corresponds to the second-level country subdivision. This field provides a short label for display in reports and address records.
HomeWorkLocationAddresscountrySubdivisionLevel2longName	String		The full descriptive name of the second-level country subdivision. This field provides the complete name for HR, payroll, and compliance reporting.
HomeWorkLocationAddresscountrySubdivisionLevel2subdivisionType	String		The type of administrative division that is represented by the second-level country subdivision (for example, County, Parish, or Province). This field clarifies jurisdictional context.
HomeWorkLocationAddressnameCodeValue	String		The code value that identifies the locality or site name within the address. This field provides a system-recognized Id for geographic and operational mapping.
HomeWorkLocationAddressnameCodeshortName	String		The abbreviated name that corresponds to the locality or site-name code. This field provides a short label for reporting and address formatting.
HomeWorkLocationAddressnameCodelongName	String		The full descriptive name of the locality or site-name code. This field provides a complete label used in HR and facilities reports.
HomeWorkLocationAddressattentionOfName	String		The name of the individual or department to whose attention correspondence should be directed. This field supports personalized address routing.
HomeWorkLocationAddresscareOfName	String		The name of the individual or entity under whose care the address is maintained. This field is used for third-party or temporary mailing arrangements.
HomeWorkLocationAddresslineOne	String		The first line of the home work-location address. This field typically contains the street number and street name.
HomeWorkLocationAddresslineTwo	String		The second line of the home work-location address. This field is used for apartment, suite, or unit details.
HomeWorkLocationAddresslineThree	String		The third line of the home work-location address. This field allows for extended address components such as building or block names.
HomeWorkLocationAddresscountrySubdivisionLevel1Value	String		The code value that identifies the first-level country subdivision (for example, State, Province, or Region). This field supports geographic and regulatory reporting.
HomeWorkLocationAddresscountrySubdivisionLevel1shortName	String		The abbreviated name that corresponds to the first-level country subdivision. This field provides a short label for dashboards and reports.
HomeWorkLocationAddresscountrySubdivisionLevel1longName	String		The full descriptive name of the first-level country subdivision. This field provides the complete label used in compliance and payroll documents.
HomeWorkLocationAddresscountrySubdivisionLevel1subdivisionType	String		The type of administrative division represented by the first-level country subdivision (for example, State, Province, or Territory). This field clarifies the jurisdictional level.
HomeWorkLocationAddresscountryCode	String		The ISO country code that identifies the country in which the home work location resides (for example, US, CA, or GB). This field supports global workforce reporting and address validation.
HomeWorkLocationAddresspostalCode	String		The postal or ZIP code that identifies the delivery area for the home work location. This field supports logistics, tax jurisdiction, and compliance reporting.
HomeWorkLocationAddressgeoCoordinateLatitude	Double		The latitude coordinate of the home work location. This field supports geospatial mapping, reporting, and workforce planning.
HomeWorkLocationAddressgeoCoordinateLongitude	Double		The longitude coordinate of the home work location. This field provides the geographic reference needed for mapping and site-level analysis.
RemunerationBasisCodeValue	String		The code value that identifies the remuneration basis for the worker's compensation (for example, Salary, Hourly,or Commission). This field defines how pay is structured for the assignment.
RemunerationBasisCodeshortName	String		The abbreviated name that corresponds to the remuneration basis code. This field provides a short label that is used in dashboards and compensation reports.
RemunerationBasisCodelongName	String		The full descriptive name of the remuneration basis code. This field provides a complete label used in payroll configuration and HR analytics.
PayCycleCodeValue	String		The code value that identifies the pay cycle or pay frequency associated with the worker's assignment (for example, Weekly, Biweekly, or Monthly). This field determines payroll timing and scheduling.
PayCycleCodeshortName	String		The abbreviated name that corresponds to the pay-cycle code. This field provides a concise label that is displayed in HR dashboards, reports, and payroll configuration tools.
PayCycleCodelongName	String		The full descriptive name of the pay-cycle code. This field provides the complete label used in payroll schedules, reporting, and workforce planning.
StandardPayPeriodHourshoursQuantity	Integer		The numeric value that represents the standard number of hours in a pay period. This field is used for payroll calculation, time tracking, and labor allocation reporting.
StandardPayPeriodHoursCodeValue	String		The code value that identifies the classification or type of standard pay-period hours (for example, Standard, Reduced, or Extended). This field defines how scheduled hours are categorized for the worker's assignment.
StandardPayPeriodHoursCodeshortName	String		The abbreviated name that corresponds to the standard pay-period hours code. This field provides a short label for dashboards and reports.
StandardPayPeriodHoursCodelongName	String		The full descriptive name of the standard pay-period hours code. This field provides a clear label that is used in HR reports, scheduling systems, and payroll documentation.
BaseRemunerationhourlyRateAmountcodeValue	String		The code value that identifies the classification associated with the worker's hourly base rate. This field is used to categorize the hourly rate for payroll and compensation analysis.
BaseRemunerationhourlyRateAmountshortName	String		The abbreviated name that corresponds to the hourly rate code. This field provides a concise label for dashboards and payroll reports.
BaseRemunerationhourlyRateAmountlongName	String		The full descriptive name of the hourly rate code. This field provides the complete label used in HR reports and compensation documentation.
BaseRemunerationhourlyRateAmountValue	String		The numeric value that represents the worker's hourly rate of pay. This field is used to calculate gross earnings for hourly employees.
BaseRemunerationhourlyRateAmountCurrencyCode	String		The three-letter ISO currency code that identifies the currency of the hourly rate amount (for example, USD, CAD, or EUR). This field ensures correct currency alignment in payroll calculations and reporting.
BaseRemunerationdailyRateAmountcodeValue	String		The code value that identifies the classification associated with the worker's daily base rate. This field categorizes the daily rate for payroll processing and compliance purposes.
BaseRemunerationdailyRateAmountshortName	String		The abbreviated name that corresponds to the daily rate code. This field provides a concise label for display in reports and pay configuration tools.
BaseRemunerationdailyRateAmountlongName	String		The full descriptive name of the daily rate code. This field provides a complete label used in payroll configuration and HR documentation.
BaseRemunerationdailyRateAmountValue	String		The numeric value that represents the worker's daily rate of pay. This field is used to calculate gross earnings for daily-compensated employees.
BaseRemunerationdailyRateAmountCurrencyCode	String		The three-letter ISO currency code that identifies the currency of the daily rate amount (for example, USD, GBP, or CAD). This field supports accurate pay calculation and cross-currency reporting.
BaseRemunerationweeklyRateAmountcodeValue	String		The code value that identifies the classification associated with the worker's weekly base rate. This field is used to categorize pay rates for weekly-paid employees.
BaseRemunerationweeklyRateAmountshortName	String		The abbreviated name that corresponds to the weekly rate code. This field provides a short label for dashboards and payroll reports.
BaseRemunerationweeklyRateAmountlongName	String		The full descriptive name of the weekly rate code. This field provides a complete label used in HR and payroll configuration documentation.
BaseRemunerationweeklyRateAmountValue	String		The numeric value that represents the worker's weekly rate of pay. This field is used to determine gross earnings for weekly-paid employees.
BaseRemunerationweeklyRateAmountCurrencyCode	String		The three-letter ISO currency code that identifies the currency of the weekly rate amount (for example, USD, CAD, or GBP). This field ensures accuracy in international payroll reporting.
BaseRemunerationbiweeklyRateAmountcodeValue	String		The code value that identifies the classification associated with the worker's biweekly base rate. This field categorizes the rate for payroll and compensation tracking.
BaseRemunerationbiweeklyRateAmountshortName	String		The abbreviated name that corresponds to the biweekly rate code. This field provides a concise label for display in dashboards and reports.
BaseRemunerationbiweeklyRateAmountlongName	String		The full descriptive name of the biweekly rate code. This field provides a complete label that appears in HR and payroll configuration documents.
BaseRemunerationbiweeklyRateAmountValue	String		The numeric value that represents the worker's biweekly rate of pay. This field is used to calculate pay for employees on a biweekly payroll cycle.
BaseRemunerationbiweeklyRateAmountCurrencyCode	String		The three-letter ISO currency code that identifies the currency of the biweekly rate amount (for example, USD, EUR, or AUD). This field ensures proper currency conversion in payroll systems.
BaseRemunerationsemiMonthlyRateAmountcodeValue	String		The code value that identifies the classification associated with the worker's semi-monthly base rate. This field categorizes the rate for semi-monthly payroll and compensation analysis.
BaseRemunerationsemiMonthlyRateAmountshortName	String		The abbreviated name that corresponds to the semi-monthly rate code. This field provides a short label for reports and compensation dashboards.
BaseRemunerationsemiMonthlyRateAmountlongName	String		The full descriptive name of the semi-monthly rate code. This field provides the complete label used in HR and payroll configuration records.
BaseRemunerationsemiMonthlyRateAmountValue	String		The numeric value that represents the worker's semi-monthly rate of pay. This field is used to calculate earnings for employees on a semi-monthly pay schedule.
BaseRemunerationsemiMonthlyRateAmountCurrencyCode	String		The three-letter ISO currency code that identifies the currency of the semi-monthly rate amount (for example, USD, CAD, or GBP). This field ensures consistency in payroll reporting and calculations.
BaseRemunerationmonthlyRateAmountcodeValue	String		The code value that identifies the classification associated with the worker's monthly base rate. This field categorizes pay for employees compensated on a monthly basis.
BaseRemunerationmonthlyRateAmountshortName	String		The abbreviated name that corresponds to the monthly rate code. This field provides a concise label used in dashboards and payroll configuration screens.
BaseRemunerationmonthlyRateAmountlongName	String		The full descriptive name of the monthly rate code. This field provides the complete label that is displayed in HR reports and payroll documentation.
BaseRemunerationmonthlyRateAmountValue	String		The numeric value that represents the worker's monthly rate of pay. This field is used to calculate gross earnings for employees on a monthly payroll schedule.
BaseRemunerationmonthlyRateAmountCurrencyCode	String		The three-letter ISO currency code that identifies the currency of the monthly rate amount (for example, USD, CAD, or EUR). This field ensures proper currency conversion and reporting consistency.
BaseRemunerationannualRateAmountcodeValue	String		The code value that identifies the classification associated with the worker's annual base rate. This field categorizes compensation for yearly-paid employees and supports reporting and compliance.
BaseRemunerationannualRateAmountshortName	String		The abbreviated name that corresponds to the annual rate code. This field provides a concise label for dashboards and HR reports.
BaseRemunerationannualRateAmountlongName	String		The full descriptive name of the annual rate code. This field provides the complete label used in payroll configuration and compensation analysis.
BaseRemunerationannualRateAmountValue	String		The numeric value that represents the worker's annual rate of pay. This field is used for total compensation reporting and executive-level payroll summaries.
BaseRemunerationannualRateAmountCurrencyCode	String		The three-letter ISO currency code that identifies the currency of the annual rate amount (for example, USD, GBP, or CAD). This field ensures consistency in payroll and financial reporting.
BaseRemunerationpayPeriodRateAmountcodeValue	String		The code value that identifies the classification associated with the pay-period rate amount. This field defines the worker's recurring pay amount per cycle for payroll processing.
BaseRemunerationpayPeriodRateAmountshortName	String		The abbreviated name that corresponds to the pay-period rate code. This field provides a short label for use in dashboards and reporting tools.
BaseRemunerationpayPeriodRateAmountlongName	String		The full descriptive name of the pay-period rate code. This field provides the complete label displayed in payroll configuration and analytics reports.
BaseRemunerationpayPeriodRateAmountValue	String		The numeric value that represents the worker's rate of pay per pay period. This field is used for calculating gross pay within each payroll cycle.
BaseRemunerationpayPeriodRateAmountCurrencyCode	String		The three-letter ISO currency code that identifies the currency of the pay-period rate amount (for example, USD, EUR, or JPY). This field supports global payroll accuracy and reporting alignment.
BaseRemunerationcommissionRatePercentagecodeValue	String		The code value that identifies the classification associated with the worker's commission rate percentage. This field defines how commission-based pay is structured for sales or incentive compensation.
BaseRemunerationcommissionRatePercentageshortName	String		The abbreviated name that corresponds to the commission-rate percentage code. This field provides a short label for reporting and configuration tools.
BaseRemunerationcommissionRatePercentagelongName	String		The full descriptive name of the commission-rate percentage code. This field provides the complete label used in HR and payroll documentation.
BaseRemunerationcommissionRatePercentageValue	String		The numeric value that represents the commission-rate percentage applied to earnings. This field determines variable pay for commission-based employees.
BaseRemunerationcommissionRatePercentagebaseUnitCodeValue	String		The code value that identifies the base unit of measure that is used for calculating commission percentages (for example, Sales Amount, Units Sold, or Revenue). This field defines the metric to which the commission rate is applied.
BaseRemunerationcommissionRatePercentageCurrencyCodeshortName	String		The abbreviated name that corresponds to the commission-rate currency code. This field provides a short label used in dashboards and reports.
BaseRemunerationcommissionRatePercentageCurrencyCodelongName	String		The full descriptive name of the commission-rate currency code. This field provides the complete label used in payroll documentation and analytics reports.
BaseRemunerationeffectiveDate	Date		The date on which the current base remuneration information became effective. This field is used to track changes in pay rates over time and supports audit reporting.
PayrollProcessingStatusCodecodeValue	String		The code value that identifies the payroll-processing status for the worker (for example, Pending, Approved, or Processed). This field defines the current payroll workflow state.
PayrollProcessingStatusCodeshortName	String		The abbreviated name that corresponds to the payroll-processing status code. This field provides a concise label for dashboards and payroll monitoring tools.
PayrollProcessingStatusCodelongName	String		The full descriptive name of the payroll-processing status code. This field provides a complete label used in HR, payroll, and compliance reports.
PayrollProcessingStatusCodeEffectiveDate	Date		The date on which the current payroll-processing status became effective. This field marks when the payroll state changed within the system.
PayrollGroupCode	String		The code that identifies the payroll group to which the worker belongs. This field groups workers for payroll processing, scheduling, and reporting.
PayrollFileNumber	String		The file number that represents the payroll file or batch in which the worker's pay data is included. This field supports reconciliation and auditing of payroll runs.
PayrollRegionCode	String		The code that identifies the payroll region associated with the worker's assignment. This field determines regional payroll rules, taxes, and compliance configurations.
PayScaleCodecodeValue	String		The code value that identifies the pay scale associated with the worker's job classification. This field defines structured compensation ranges used for salary administration.
PayScaleCodeshortName	String		The abbreviated name that corresponds to the pay-scale code. This field provides a concise label for dashboards, reports, and job evaluation tools.
PayScaleCodelongName	String		The full descriptive name of the pay-scale code. This field provides the complete label used in HR reports and compensation management systems.
PayGradeCodecodeValue	String		The code value that identifies the pay-grade level associated with the worker's position. This field defines pay structure within the organization's compensation framework.
PayGradeCodeshortName	String		The abbreviated name that corresponds to the pay-grade code. This field provides a short label used in dashboards and HR analytics reports.
PayGradeCodelongName	String		The full descriptive name of the pay-grade code. This field provides the complete label that appears in HR and payroll reports.
PayGradePayRangeminimumRateamountValue	String		The numeric value that represents the minimum rate of pay within the pay-grade range. This field defines the lower limit for the compensation range.
PayGradePayRangeminimumRatecurrencyCode	String		The three-letter ISO currency code that identifies the currency used for the minimum rate amount (for example, USD, CAD, or GBP). This field ensures proper payroll currency consistency.
PayGradePayRangeminimumRateUnitCodeValue	String		The code value that identifies the unit of measure for the minimum rate (for example, Hourly, Weekly, or Annual). This field specifies how the pay rate is calculated.
PayGradePayRangeminimumRateUnitshortName	String		The abbreviated name that corresponds to the minimum rate-unit code. This field provides a concise label for reports and pay structure documentation.
PayGradePayRangeminimumRateUnitlongName	String		The full descriptive name of the minimum rate-unit code. This field provides the complete label that is used in HR and compensation reports.
PayGradePayRangeminimumRateBaseUnitCodeValue	String		The code value that identifies the base unit of measure used to calculate the minimum rate (for example, Hour, Day, or Month). This field defines the rate basis for payroll calculations.
PayGradePayRangeminimumRateBaseUnitshortName	String		The abbreviated name that corresponds to the minimum rate-base unit code. This field provides a short label for dashboards and reports.
PayGradePayRangeminimumRateBaseUnitlongName	String		The full descriptive name of the minimum rate base unit code. This field provides the complete label used in payroll and compensation documentation.
PayGradePayRangeminimumRatebaseMultiplierValue	Integer		The numeric multiplier that is applied to the base rate to determine the minimum pay rate. This field is used for pay scale conversions and compensation modeling.
PayGradePayRangemedianRateamountValue	String		The numeric value that represents the median rate of pay within the pay-grade range. This field defines the midpoint of the compensation range.
PayGradePayRangemedianRatecurrencyCode	String		The three-letter ISO currency code that identifies the currency of the median-rate amount (for example, USD, EUR, or CAD). This field ensures currency accuracy in reporting.
PayGradePayRangemedianRateUnitCodeValue	String		The code value that identifies the unit of measure for the median rate (for example, Hourly, Weekly, or Annual). This field specifies how the median pay rate is defined.
PayGradePayRangemedianRateUnitshortName	String		The abbreviated name that corresponds to the median-rate unit code. This field provides a short label for reports and dashboards.
PayGradePayRangemedianRateBaseUnitCodeValue	String		The code value that identifies the base unit of measure for the median rate (for example, Hour, Day, or Month). This field defines the standard basis for payroll calculations.
PayGradePayRangemedianRateBaseUnitshortName	String		The abbreviated name that corresponds to the median-rate base unit code. This field provides a concise label for dashboards and summary reports.
PayGradePayRangemedianRateBaseUnitlongName	String		The full descriptive name of the median-rate base unit code. This field provides the complete label for HR, payroll, and compensation documentation.
PayGradePayRangemedianRatebaseMultiplierValue	Integer		The numeric multiplier that is applied to the base rate to calculate the median rate. This field is used in compensation modeling and analytics.
PayGradePayRangemaximumRateamountValue	String		The numeric value that represents the maximum rate of pay within the pay-grade range. This field defines the upper limit of the compensation range for the job classification.
PayGradePayRangemaximumRatecurrencyCode	String		The three-letter ISO currency code that identifies the currency of the maximum rate amount (for example, USD, CAD, or GBP). This field supports consistent payroll calculations and reporting.
PayGradePayRangemaximumRateUnitCodeValue	String		The code value that identifies the unit of measure for the maximum rate (for example, Hourly, Weekly, or Annual). This field defines how the pay rate is calculated.
PayGradePayRangemaximumRateUnitshortName	String		The abbreviated name that corresponds to the maximum-rate unit code. This field provides a concise label for reports and compensation tools.
PayGradePayRangemaximumRateUnitlongName	String		The full descriptive name of the maximum-rate unit code. This field provides the complete label that is used in HR, payroll, and compensation documentation.
PayGradePayRangemaximumRateBaseUnitCodeValue	String		The code value that identifies the base unit of measure for the maximum rate (for example, Hour, Day, or Month). This field defines the unit basis for pay structure calculations.
PayGradePayRangemaximumRateBaseUnitshortName	String		The abbreviated name that corresponds to the maximum-rate base unit code. This field provides a concise label for dashboards and payroll configuration reports.
PayGradePayRangemaximumRateBaseUnitlongName	String		The full descriptive name of the maximum-rate base unit code. This field provides the complete label used in compensation and HR documentation.
PayGradePayRangemaximumRatebaseMultiplierValue	Integer		The numeric multiplier that is applied to the base rate to determine the maximum pay rate. This field is used in compensation modeling and pay structure analysis.
CompaRatio	Double		The compensation ratio value that compares an employee's current pay to the midpoint or range of the pay grade. This field is used in compensation analysis to assess pay equity and alignment.
PayGradeStepCodeValue	String		The code value that identifies the pay-grade step associated with the worker's position. This field defines the specific level or progression point within a structured pay grade.
PayGradeStepshortName	String		The abbreviated name that corresponds to the pay-grade step code. This field provides a concise label for reports and HR dashboards.
PayGradeSteplongName	String		The full descriptive name of the pay-grade step code. This field provides the complete label used in HR and compensation reports.
PayGradeStepPayRateamountValue	String		The numeric value that represents the rate of pay for the pay-grade step. This field defines the specific compensation amount at the given step within the pay grade.
PayGradeStepPayRatecurrencyCode	String		The three-letter ISO currency code that identifies the currency of the pay rate for the pay-grade step (for example, USD, CAD, or GBP). This field ensures currency consistency in payroll calculations.
PayGradeStepPayRateUnitCodeValue	String		The code value that identifies the unit of measure for the pay-grade step rate (for example, Hourly, Weekly, or Annual). This field defines how the rate is expressed.
PayGradeStepPayRateUnitshortName	String		The abbreviated name that corresponds to the pay-rate unit code. This field provides a short label for reports and dashboards.
PayGradeStepPayRateUnitlongName	String		The full descriptive name of the pay-rate unit code. This field provides the complete label used in HR and compensation documentation.
PayGradeStepPayRateBaseUnitCodeValue	String		The code value that identifies the base unit of measure for the pay-grade step rate (for example, Hour, Day, or Month). This field defines the rate basis for payroll calculations.
PayGradeStepPayRateBaseUnitshortName	String		The abbreviated name that corresponds to the base unit code for the pay-grade step rate. This field provides a concise label for dashboards and summary reports.
PayGradeStepPayRateBaseUnitlongName	String		The full descriptive name of the base unit code for the pay-grade step rate. This field provides a complete label for HR and payroll reports.
PayGradeStepPayRatebaseMultiplierValue	Integer		The numeric multiplier that is applied to the base rate to calculate the pay-grade step rate. This field supports compensation modeling and range calculations.
NextPayGradeStepDate	Date		The date on which the worker is scheduled to advance to the next pay-grade step. This field supports career progression and compensation planning. MinimumPayGradeStepDuration,column:string,The minimum required duration that a worker must remain in the current pay-grade step before becoming eligible for advancement. This field ensures compliance with progression policies.
MinimumPayGradeStepDuration	String
GeographicPayDifferentialCodeValue	String		The code value that identifies the geographic pay differential applicable to the worker's location. This field accounts for regional cost-of-living or market rate adjustments.
GeographicPayDifferentialshortName	String		The abbreviated name that corresponds to the geographic pay-differential code. This field provides a concise label for reports and compensation dashboards.
GeographicPayDifferentiallongName	String		The full descriptive name of the geographic pay-differential code. This field provides the complete label used in HR, payroll, and compliance reports.
GeographicPayDifferentialPercentage	Double		The percentage value that represents the adjustment applied to base pay as a result of geographic differences. This field supports equitable compensation across regions.
ItemID	String		The unique Id that represents the individual historical record for this work assignment. This Id is used to track changes and maintain version history across the worker's employment timeline.
EffectiveDate	Date		The date on which the current record or change became effective. This field is used to determine when updates to the worker's assignment or compensation take effect.
FromDate	Date		The start date of the period during which this historical record is valid. This field defines the beginning of the effective period for the record.
ThruDate	Date		The end date of the period during which this historical record is valid. This field defines when the record ceases to be effective.
HistoryEventID	String		The unique Id that represents the historical event recorded in this entry. This Id links the change to specific actions or transactions within the HR system.
HistoryEventNameCodeValue	String		The code value that identifies the type of historical event (for example, Hire, Promotion, or Termination). This field classifies the event type for reporting and auditing.
HistoryEventNameshortName	String		The abbreviated name that corresponds to the historical-event code. This field provides a short label for dashboards and event summaries.
HistoryEventNamelongName	String		The full descriptive name of the historical-event code. This field provides the complete label for HR and compliance reports.
HistoryReasonCodeValue	String		The code value that identifies the reason for the historical event (for example, Transfer, Pay Adjustment, or Job Change). This field provides additional context for event tracking.
HistoryReasonshortName	String		The abbreviated name that corresponds to the history-reason code. This field provides a concise label for reports and analytics dashboards.
HistoryReasonlongName	String		The full descriptive name of the history-reason code. This field provides the complete label used in HR and payroll documentation.
HistoryEventActorId	String		The unique Id that represents the actor responsible for the historical event. This Id identifies the person, system, or process that performed the action.
HistoryEventActorCodeValue	String		The code value that identifies the type of actor associated with the historical event (for example, Employee, Manager, or System). This field defines the role that initiated the change.
HistoryEventActorshortName	String		The abbreviated name that corresponds to the actor code. This field provides a concise label for reports and audit dashboards.
HistoryEventActorlongName	String		The full descriptive name of the actor code. This field provides the complete label used in HR and system audit records.
HistoryEventActorassociateOID	String		The Id that represents the associate involved in the historical event. This field links the action to the correct worker record in HR systems.
HistoryEventActorpersonOID	String		The Id that represents the person associated with the historical-event actor. This field provides an additional reference for cross-system identification.
HistoryEventActorformattedName	String		The formatted full name of the historical-event actor. This field provides a readable name for display in HR reports, audit logs, and analytics tools.
HistoryEventActordeviceID	String		The Id that represents the device used to perform the historical event. This field supports audit tracking and security verification.
HistoryEventActorlatitude	Double		The latitude coordinate captured when the historical event occurred. This field supports audit tracking, compliance verification, and geolocation analysis.
HistoryEventActorlongitude	Double		The longitude coordinate captured when the historical event occurred. This field complements the latitude field for geographic audit tracking.
HistoryEventActordeviceUserAgentID	String		The Id of the user agent or application that executed the historical event. This field is used for system audits and device traceability.
WorkAssignmentID	String		The unique Id that represents the specific work assignment associated with this historical record. This Id links all related events, pay details, and organizational changes.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this historical work-assignment record belongs. This field ensures that all historical changes are properly linked to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryAdditionalRemunerations

The view that returns historical records of additional remunerations that are associated with work assignments. This view captures supplemental earnings (for example, bonuses or allowances) that are applied to past payroll periods for auditing and reconciliation.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryAdditionalRemunerations WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
TypeCodeValue	String		The code value that identifies the type of additional remuneration assigned to the worker. This field classifies supplemental pay categories (for example, Bonus, Commission, or Allowance).
TypeCodeCodeshortName	String		The abbreviated name that corresponds to the additional-remuneration type code. This field provides a concise label used in Human Resources (HR) and payroll reports.
TypeCodeCodelongName	String		The full descriptive name of the additional-remuneration type code. This field provides the complete label displayed in HR, payroll, and compensation analytics.
IntervalCodeCodeValue	String		The code value that identifies the interval or frequency associated with the additional remuneration (for example, Weekly, Monthly, or Annual). This field defines how often the remuneration is applied.
IntervalCodeCodeCodeshortName	String		The abbreviated name that corresponds to the remuneration interval code. This field provides a short label for dashboards and payroll reports.
IntervalCodeCodeCodelongName	String		The full descriptive name of the remuneration interval code. This field provides the complete label that appears in HR and payroll documentation.
NameCodeCodeValue	String		The code value that identifies the name or type of the additional remuneration record. This field defines what the remuneration represents within the worker's compensation history.
NameCodeCodeCodeshortName	String		The abbreviated name that corresponds to the remuneration name code. This field provides a short label for quick reference in dashboards and HR reports.
NameCodeCodeCodelongName	String		The full descriptive name of the remuneration name code. This field provides a complete label used in payroll configuration and compensation analysis.
RateAmountValue	Integer		The numeric value that represents the rate amount for the additional remuneration. This field defines the specific monetary value that is applied during payroll processing.
RateCurrencyCode	String		The three-letter ISO currency code that identifies the currency in which the remuneration amount is paid (for example, USD, CAD, or GBP). This field ensures consistency in multi-currency payroll environments.
RateUnitCode	String		The code value that identifies the unit of measure associated with the remuneration rate (for example, Hourly, Daily, or Annual). This field defines how the rate is calculated or applied.
RateshortName	String		The abbreviated name that corresponds to the remuneration rate code. This field provides a short label for display in dashboards and summary reports.
RateLongName	String		The full descriptive name of the remuneration rate code. This field provides the complete label used in HR and payroll documentation.
RateBaseUnitCode	String		The code value that identifies the base unit of measure that is used to determine the remuneration rate (for example, Hour, Day, or Month). This field defines the unit basis for payroll calculations.
RateBaseshortName	String		The abbreviated name that corresponds to the base unit code for the remuneration rate. This field provides a concise label for reports and dashboards.
RateBaseLongName	String		The full descriptive name of the base unit code for the remuneration rate. This field provides a clear label that appears in HR, payroll, and compensation reports.
BaseMultiplierValue	Integer		The numeric multiplier value that is applied to the base rate to calculate the final remuneration amount. This field supports pay differentials and complex compensation structures.
ItemID	String		The unique identifier (Id) that represents the specific additional remuneration record within the worker's assignment history. This Id enables tracking and audit of supplemental pay transactions.
EffectiveDate	Date		The date on which the additional remuneration becomes effective. This field is used to determine when the change or adjustment takes effect in payroll processing.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this additional remuneration record belongs. This field links the pay record to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryAssignedOrganizationalUnits

The view that returns the historical record of organizational units that are assigned to each work assignment. This view tracks how an associate's reporting structure and departmental affiliations have changed over time. This data supports organizational audits and workforce mobility analysis.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryAssignedOrganizationalUnits WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
NameCodeValue	String		The code value that identifies the name of the organizational unit assigned to the worker. This field specifies the department, division, or team to which the worker is linked (for example, Sales, Finance, or Operations).
NameCodeshortName	String		The abbreviated name that corresponds to the organizational-unit name code. This field provides a short label for dashboards, Human Resources (HR) reports, and organizational charts.
NameCodelongName	String		The full descriptive name of the organizational-unit name code. This field provides the complete label that appears in HR, payroll, and workforce planning documentation.
TypeCodeValue	String		The code value that identifies the type of organizational unit (for example, Department, Cost Center, or Business Unit). This field defines the structural classification of the unit within the organization.
TypeCodeshortName	String		The abbreviated name that corresponds to the organizational-unit type code. This field provides a concise label for reports and summary views.
TypeCodelongName	String		The full descriptive name of the organizational-unit type code. This field provides the complete label used in HR and organizational structure reports.
itemID	String		The unique identifier (Id) that represents the specific assigned organizational-unit record. This Id is used to track the worker's assignment history and maintain audit accuracy.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom the assigned organizational-unit record belongs. This field links the organizational relationship to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryAssignedWorkLocations

The view that returns the historical record of work locations that are assigned to each associate's work assignment. This view captures location transfers, remote-work changes, and other location-based adjustments that are relevant for payroll taxation and compliance tracking.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryAssignedWorkLocations WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate assigned to this work location. This Id links the work-location record to the correct worker profile within Human Resources (HR) and payroll systems.
AddressScriptCode	String		The code value that identifies the address script or format that is used for the assigned work location. This field ensures address data is formatted consistently according to regional or country standards.
AddressShortName	String		The abbreviated name that corresponds to the address script code. This field provides a short label used in system configuration, reports, and address formatting.
AddressLongName	String		The full descriptive name of the address script code. This field provides the complete label that appears in HR, payroll, and location management reports.
AddressLineFour	String		The fourth line of the assigned work-location address. This field stores additional address details that are used for extended delivery or routing information.
AddressLineFive	String		The fifth line of the assigned work-location address. This field is available for supplemental details that support complex or multi-part address structures.
AddressBuildingNumber	String		The number that identifies the specific building at the work location. This field is used for mail delivery, navigation, and compliance reporting.
AddressBuildingName	String		The name of the building associated with the assigned work location. This field identifies the physical structure used for HR reporting and facility management.
AddressBlockName	String		The block, district, or development name in which the building is located. This field provides regional context for mapping and logistical purposes.
AddressStreetName	String		The name of the street where the assigned work location is situated. This field provides the primary street Id used in mailing, mapping, and compliance reporting.
AddressStreetTypeCode	String		The code value that identifies the type of street (for example, Avenue, Road, or Boulevard). This field defines the classification of the street in the address record.
AddressStreetTypeShortName	String		The abbreviated name that corresponds to the street type code. This field provides a short label for dashboards and address summaries.
AddressStreetTypeLongName	String		The full descriptive name of the street type code. This field provides the complete label used in HR, payroll, and facilities reports.
AddressUnit	Integer		The unit number or Id within the building. This field identifies the suite, apartment, or office number used for correspondence and site access.
AddressFloor	String		The floor number or designation within the building. This field identifies where the associate's workspace or department is located.
AddressStairCase	String		The stairwell or section Id in a multi-unit building. This field supports internal wayfinding and emergency planning documentation.
AddressDoor	String		The door or room Id for the assigned work location. This field provides specific access information for internal navigation or security records.
AddressPostOfficeBox	String		The post office (PO) box number that is used for correspondence if the work location receives mail through a PO box instead of a physical address.
AddressDeliveryPoint	String		The designated delivery point or routing code for mail delivery. This field ensures accurate and efficient postal distribution.
AddressPlotID	String		The unique plot or parcel Id assigned to the property. This field supports mapping, facility management, and land use documentation.
AddressCountrySubdivisionLevel2	String		The code value that identifies the second-level country subdivision (for example, County, District, or Municipality). This field supports regional and compliance reporting.
AddressCountrySubdivisionLevel2ShortName	String		The abbreviated name that corresponds to the second-level country subdivision. This field provides a short label used in dashboards and reports.
AddressCountrySubdivisionLevel2LongName	String		The full descriptive name of the second-level country subdivision. This field provides the complete label for HR and geographic reports.
AddressCountrySubdivisionLevel2Type	String		The type of administrative division represented by the second-level country subdivision (for example, County, District, or Province). This field clarifies jurisdictional context.
AddressCountrySubdivisionLevel1	String		The code value that identifies the first-level country subdivision (for example, State, Province, or Region). This field supports geographic, tax, and compliance reporting.
AddressCountrySubdivisionShortName	String		The abbreviated name that corresponds to the first-level country subdivision. This field provides a short label for use in dashboards and address summaries.
AddressCountrySubdivisionLongName	String		The full descriptive name of the first-level country subdivision. This field provides the complete label for HR, payroll, and compliance reports.
AddressCountrySubdivisionType	String		The type of administrative division represented by the first-level country subdivision (for example, State, Province, or Territory). This field defines the jurisdictional level for reporting purposes.
AddressNameCode	String		The code value that identifies the name or reference label for the address (for example, Headquarters, Branch Office, or Remote Site). This field defines the purpose of the assigned location.
AddressNameShortName	String		The abbreviated name that corresponds to the address name code. This field provides a concise label for dashboards and location management tools.
AddressNameLongName	String		The full descriptive name of the address name code. This field provides a complete label for HR, payroll, and organizational reports.
AddressAttentionOfName	String		The name of the individual or department to whose attention correspondence should be sent. This field supports personalized delivery and contact accuracy.
AddressCareOfName	String		The name of the individual or entity under whose care the address is maintained. This field is used for third-party or alternate mailing arrangements.
AddressLineOne	String		The first line of the assigned work-location address. This field typically contains the building number and street name.
AddressLineTwo	String		The second line of the assigned work-location address. This field is used for apartment, suite, or floor information.
AddressLineThree	String		The third line of the assigned work-location address. This field supports extended address details for multi-tenant or complex buildings.
AddressCityName	String		The name of the city, town, or municipality in which the assigned work location resides. This field supports payroll tax jurisdiction and compliance reporting.
AddressCountryCode	String		The ISO country code that identifies the country of the assigned work location (for example, US, CA, or GB). This field supports global payroll and workforce analytics.
AddressPostalCode	String		The postal or ZIP code for the assigned work location. This field is used for mail delivery, tax, and compliance reporting.
AddressLatitude	Double		The latitude coordinate of the assigned work location. This field provides geospatial reference for mapping and workforce distribution analysis.
AddressLongitude	Double		The longitude coordinate of the assigned work location. This field provides the complementary geospatial reference for mapping and audit tracking.
NameCode	String		The code value that identifies the name of the assigned work location. This field defines the specific work site or facility associated with the worker's assignment (for example, Corporate HQ, Distribution Center, or Field Office).
NameShortName	String		The abbreviated name that corresponds to the assigned work-location name code. This field provides a short label used in HR dashboards, reports, and analytics tools.
NameLongName	String		The full descriptive name of the assigned work-location name code. This field provides the complete label used in HR documentation, payroll systems, and workforce planning reports.

WorkAssignmentHistoryCommunicationsEmails

The view that returns historical email communication details that are associated with work assignments. This view maintains a record of email addresses used by workers over time for internal correspondence and audit verification.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryCommunicationsEmails WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
EmailUri	String		The uniform resource identifier (URI) that represents the worker's email address. This field stores the primary or alternate email contact used for official communications (for example, work, personal, or notification).
ItemID	String		The unique identifier (Id) that represents the individual email record within the worker's communication history. This Id enables tracking of historical contact information across assignment periods.
NameCodeCodeValue	String		The code value that identifies the type of email address associated with the worker. This field defines the classification of the email (for example, Business, Personal, or Emergency Contact).
NameCodeLongName	String		The full descriptive name of the email-address type code. This field provides the complete label that appears in Human Resources (HR) reports and communication records.
NameCodeShortName	String		The abbreviated name that corresponds to the email-address type code. This field provides a short label for dashboards, reports, and HR analytics.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this email record belongs. This field links the communication record to the correct worker profile in HR and payroll systems.

WorkAssignmentHistoryCommunicationsFaxes

The view that returns historical fax communication records for work assignments. This view preserves legacy fax contact data that is associated with employee assignments for historical or compliance purposes.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryCommunicationsFaxes WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
Access	String		The access code or prefix that is used to initiate the fax transmission. This field defines the dialing sequence that is required before the main number (for example, 9 for an outside line, and so on).
AreaDialing	String		The area dialing code that identifies the regional fax area. This field is used to route fax transmissions within a specific country or region (for example, 212 for New York, 213 for Los Angeles, and so on).
CountryDialing	String		The international country dialing code that identifies the country of the fax number (for example, 1 for the United States, 44 for the United Kingdom, and so on). This field supports accurate routing for international fax communications.
DialNumber	String		The primary fax number that is dialed after the access, area, and country codes. This field represents the full contact number that is associated with the worker's fax record.
Extension	String		The internal extension number that is used to route the fax transmission to a specific department or device within the organization. This field supports internal routing for shared fax systems.
FormattedNumber	String		The fully formatted fax number that includes access, area, country, and extension details. This field presents the number in a readable format for Human Resources (HR) reports and communication records.
ItemID	String		The unique identifier (Id) that represents the individual fax record within the worker's communication history. This Id enables audit tracking and version control across assignment updates.
NameCode.codeValue	String		The code value that identifies the classification of the fax number. This field defines the type or purpose of the fax line (for example, Work, Personal, or Departmental, and so on).
NameCode.longName	String		The full descriptive name of the fax-number type code. This field provides the complete label that appears in HR reports and communication directories.
NameCode.shortName	String		The abbreviated name that corresponds to the fax-number type code. This field provides a short label for dashboards, summaries, and HR analytics.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this fax record belongs. This field links the communication record to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryCommunicationsInstantMessages

The view that returns historical instant-messaging contact data that is linked to work assignments. This view supports audit and compliance reviews of internal communication methods over time.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryCommunicationsInstantMessages WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
ItemID	String		The unique identifier (Id) that represents the individual instant-messaging record within the worker's communication history. This Id enables tracking of contact methods across work assignments and HR systems.
NameCode.codeValue	String		The code value that identifies the classification of the instant-messaging account. This field defines the type or platform of messaging that is used for work communications (for example, Teams, Slack, or Skype).
NameCode.longName	String		The full descriptive name of the type code for the instant-messaging account. This field provides the complete label that appears in Human Resources (HR) reports and communication directories.
NameCode.shortName	String		The abbreviated name that corresponds to the type code for the instant-messaging account. This field provides a short label for dashboards, analytics, and HR summaries.
Uri	String		The uniform resource identifier (URI) that represents the worker's instant messaging-address. This field stores the communication endpoint that is used for chat or collaboration tools.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this instant-messaging record belongs. This field links the communication record to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryCommunicationsInternetAddresses

The view that returns historical records of internet addresses that area associated with work assignments. This view includes data (for example, employee website or network Ids) that are tracked for security and compliance.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryCommunicationsInternetAddresses WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
ItemID	String		The unique identifier (Id) that represents the individual internet-address record within the worker's communication history. This Id enables tracking of web-based contact points across work assignments and HR systems.
NameCode.codeValue	String		The code value that identifies the classification of the internet address. This field defines the type or purpose of the web address that is used for communication or access (for example, Website, Profile, or Portfolio).
NameCode.longName	String		The full descriptive name of the type code for the internet address. This field provides the complete label that appears in Human Resources (HR) reports and communication directories.
NameCode.shortName	String		The abbreviated name that corresponds to the type code for the internet address. This field provides a short label for dashboards, analytics, and HR summaries.
Uri	String		The uniform resource identifier (URI) that represents the worker's internet address. This field stores the complete URI that is used for contact, collaboration, or verification purposes.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this internet-address record belongs. This field links the web contact record to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryCommunicationsLandlines

The view that returns historical landline communication details that are associated with work assignments. This view records telephone contact numbers that were active during prior assignment periods for reference and compliance reporting.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryCommunicationsLandlines WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
Access	String		The access code or prefix that is used to initiate a landline telephone call. This field defines the dialing sequence that is required before the main number (for example, 9 for an outside line).
AreaDialing	String		The area dialing code that identifies the regional telephone area. This field is used to route calls correctly within a country or region (for example, 212 for New York or 213 for Los Angeles).
CountryDialing	String		The international country dialing code that identifies the country of the landline number (for example, 1 for the United States or 44 for the United Kingdom). This field ensures proper routing for international calls.
DialNumber	String		The full landline telephone number that is dialed after the access, area, and country codes. This field represents the worker's contact number that is stored for Human Resources (HR) and communication purposes.
Extension	String		The internal extension number that routes the call to a specific department or desk within the organization. This field supports internal dialing for shared phone systems.
FormattedNumber	String		The fully formatted version of the landline telephone number that includes access, area, country, and extension details. This field provides a standardized format for HR reports and communication directories.
ItemID	String		The unique identifier (Id) that represents the individual landline communication record within the worker's contact history. This Id is used to track and audit phone records over time.
NameCode.codeValue	String		The code value that identifies the classification of the landline number. This field defines the purpose or context of the phone record (for example, Work, Home, or Department).
NameCode.longName	String		The full descriptive name of the landline number type code. This field provides the complete label that appears in HR communication reports and directories.
NameCode.shortName	String		The abbreviated name that corresponds to the landline-number type code. This field provides a concise label for dashboards, reports, and HR analytics.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this landline record belongs. This field links the communication record to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryCommunicationsMobiles

The view that returns historical mobile-phone contact data for each work assignment. This view tracks changes in mobile communication channels used by associates for accessibility and Human Resources (HR) audit purposes.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryCommunicationsMobiles WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
Access	String		The access code or prefix that is used to initiate a mobile telephone call. This field defines the dialing sequence that is required before the main number (for example, 9 for an outside line).
AreaDialing	String		The area dialing code that identifies the regional mobile-service area. This field is used to route calls correctly within a country or region (for example, 212 for New York or 213 for Los Angeles).
CountryDialing	String		The international country dialing code that identifies the country of the mobile number (for example, 1 for the United States or 44 for the United Kingdom). This field ensures proper routing for international calls and text messages.
DialNumber	String		The full mobile number that is dialed after the access, area, and country codes. This field represents the worker's primary or secondary contact number that is stored for HR and communication purposes.
Extension	String		The internal extension number, if applicable, that routes the call to a specific department or device within an organization. This field is used primarily in hybrid mobile or Voice over IP (VoIP) systems.
FormattedNumber	String		The fully formatted version of the mobile number that includes access, area, country, and extension details. This field provides a standardized format that is displayed in HR reports and communication directories.
ItemID	String		The unique identifier (Id) that represents the individual mobile-communication record within the worker's contact history. This Id enables tracking and auditing of mobile communication details across work assignments.
NameCode.codeValue	String		The code value that identifies the classification of the mobile number. This field defines the purpose or type of the mobile record (for example, Work, Personal, or Emergency).
NameCode.longName	String		The full descriptive name of the type code for the mobile number. This field provides the complete label that appears in HR communication reports and directories.
NameCode.shortName	String		The abbreviated name that corresponds to the type mode for the mobile number. This field provides a concise label for dashboards, reports, and HR analytics.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this mobile record belongs. This field links the communication record to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryCommunicationsPagers

The view that returns historical pager contact data that is associated with work assignments. This view supports legacy communication recordkeeping and historical audit reviews.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryCommunicationsPagers WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
Access	String		The access code or prefix that is used to initiate a pager transmission. This field defines the dialing sequence that is required before the main number (for example, 9 for an outside line).
AreaDialing	String		The area dialing code that identifies the regional service area for a pager. This field is used to route pager transmissions within a specific country or region (for example, 212 for New York or 213 for Los Angeles).
CountryDialing	String		The international country dialing code that identifies the country of the pager number (for example, 1 for the United States or 44 for the United Kingdom). This field ensures proper routing for international paging systems.
DialNumber	String		The full pager number that is dialed after the access, area, and country codes. This field represents the numeric identifier that directs messages to the correct device or service.
Extension	String		The internal extension number that is used to route a message to a specific individual or department within a shared paging system. This field supports targeted message delivery in large organizations.
FormattedNumber	String		The fully formatted pager number that includes access, area, country, and extension details. This field provides a standardized representation for Human Resources (HR) communication records and reports.
ItemID	String		The unique identifier (Id) that represents the individual pager-communication record within the worker's contact history. This Id enables tracking and auditing of paging details across assignment changes.
NameCode.codeValue	String		The code value that identifies the classification of the pager number. This field defines the purpose or type of the pager record (for example, Work, Emergency, or Departmental).
NameCode.longName	String		The full descriptive name of the type code for the pager number. This field provides the complete label that appears in HR communication directories and reports.
NameCode.shortName	String		The abbreviated name that corresponds to the type code for the pager number. This field provides a concise label for dashboards, reports, and HR analytics.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this pager record belongs. This field links the communication record to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryCommunicationsSocialNetworks

The view that returns historical social-network contact information that is linked to work assignments. This view captures professional network Ids used in Human Resources (HR) systems for profile completeness and compliance documentation.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryCommunicationsSocialNetworks WHERE AssociateOID = 'AOID4J5VGEX1620N';

Columns


Name	Type	References	Description
ItemID	String		The unique identifier (Id) that represents the individual social-network communication record within the worker's contact history. This Id enables tracking of external communication channels across assignments and HR systems.
NameCode.codeValue	String		The code value that identifies the classification of the social-network account. This field defines the platform or type of social connection (for example, LinkedIn, X (formerly Twitter), or Yammer).
NameCode.longName	String		The full descriptive name of the type code for the social-network account. This field provides the complete label that appears in HR communication directories and reports.
NameCode.shortName	String		The abbreviated name that corresponds to the type code for the social-network account. This field provides a concise label for dashboards, summaries, and HR analytics.
Uri	String		The uniform resource identifier (URI) that represents the worker's social network address. This field stores the profile link or network handle that is used for professional communication and collaboration.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this social-network record belongs. This field links the communication record to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryHomeOrganizationalUnits

The view that returns the historical record of home organizational units for each associate's work assignment. This view identifies an employee's primary business unit over time for historical analysis and payroll allocation.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryHomeOrganizationalUnits WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
NameCodeValue	String		The code value that identifies the name of the home organizational unit assigned to the worker. This field specifies the primary department, division, or team where the worker is based (for example, Operations, Sales, or Human Resources).
NameCodeshortName	String		The abbreviated name that corresponds to the code for the home organizational unit. This field provides a concise label that is used in dashboards, HR reports, and workforce summaries.
NameCodelongName	String		The full descriptive name of the code for the home organizational unit. This field provides the complete label that appears in Human Resources (HR) reports, payroll systems, and organizational charts.
TypeCodeValue	String		The code value that identifies the type of organizational unit (for example, Department, Cost Center, or Business Unit). This field defines the structural classification of the home unit within the organization.
TypeCodeshortName	String		The abbreviated name that corresponds to the type code for the organizational unit. This field provides a short label for reports and summary views.
TypeCodelongName	String		The full descriptive name of the type code for the organizational unit. This field provides the complete label used in HR and workforce structure documentation.
itemID	String		The unique identifier (Id) that represents the specific record for the home organizational unit within the worker's assignment history. This Id enables tracking of changes in primary organizational alignment over time.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom the record for home organizational unit belongs. This field links the organizational assignment to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryIndustryClassifications

The view that returns historical industry classification codes that are associated with work assignments. This view tracks the classification of roles or departments according to industry-standard codes that are used for compliance and reporting.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryIndustryClassifications WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
nameCodeValue	String		The code value that identifies the industry classification name that is associated with the worker's home work assignment. This field defines the primary business or operational category under which the assignment falls (for example, Manufacturing, Finance, or Healthcare).
nameCodeshortName	String		The abbreviated name that corresponds to the name code for the industry classification. This field provides a short label that is used in dashboards, Human Resources (HR) reports, and organizational summaries.
nameCodelongName	String		The full descriptive name of the code for the industry classification. This field provides the complete label that appears in HR documentation, payroll systems, and compliance reports.
classificationCodeValue	String		The code value that identifies the specific classification standard applied to the worker's home assignment (for example, NAICS, SIC, or ISIC). This field defines how the organization's industry segment is categorized for regulatory and reporting purposes.
classificationCodeshortName	String		The abbreviated name that corresponds to the industry classification code. This field provides a concise label for reports and analytics dashboards.
classificationCodelongName	String		The full descriptive name of the industry classification code. This field provides the complete label that is used in HR, compliance, and workforce analytics reports.
itemID	String		The unique identifier (Id) that represents the individual industry classification record within the worker's home assignment history. This Id enables tracking of industry alignment for reporting and auditing purposes.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this industry classification record belongs. This field links the industry classification to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryOccupationalClassifications

The view that returns historical occupational classification codes for work assignments. This view maintains standardized occupation data for regulatory reporting and labor statistics tracking.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryOccupationalClassifications WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
nameCodeValue	String		The code value that identifies the occupational classification name associated with the worker's assignment. This field specifies the role or job category that defines the nature of the worker's duties (for example, Administrative, Technical, or Professional).
nameCodeshortName	String		The abbreviated name that corresponds to the code for the occupational classification name. This field provides a concise label that is used in dashboards, Human Resources (HR) reports, and organizational analytics.
nameCodelongName	String		The full descriptive name of the code for the occupational classification name. This field provides the complete label that appears in HR documentation, payroll systems, and compliance reports.
classificationCodeValue	String		The code value that identifies the specific occupational classification standard that is applied to the worker's role (for example, SOC, ISCO, or O*NET). This field defines how the job is categorized for reporting and regulatory purposes.
classificationCodeshortName	String		The abbreviated name that corresponds to the code for the occupational classification. This field provides a short label for HR dashboards, reports, and analytics summaries.
classificationCodelongName	String		The full descriptive name of the code for the occupational classification. This field provides the complete label that is used in HR, compliance, and workforce planning documentation.
itemID	String		The unique identifier (Id) that represents the individual occupational-classification record within the worker's assignment history. This Id enables tracking and auditing of occupational data across time.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this occupational-classification record belongs. This field links the classification record to the correct worker profile within HR and payroll systems.

WorkAssignmentHistoryReport

The view that compiles a comprehensive report of historical work-assignment records. This view integrates multiple dimensions (for example, organizational units, locations, and communication fields) into a unified dataset for compliance and workforce analysis.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryReport WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate whose work-assignment report record is being captured. This Id links the report entry to the correct worker profile within Human Resources (HR) and payroll systems.
WorkerIDValue	String	Workers.WorkerID	The value of the worker's identification code that is assigned by the organization. This field uniquely identifies the worker across HR, payroll, and compliance systems.
WorkerIDschemeCode	String		The code that defines the scheme or format used for the worker identification value (for example, EmployeeNumber, ContractorID, or TemporaryID). This field clarifies how the worker's Id is structured within the organization's system.
WorkerIDShortName	String		The abbreviated name that corresponds to thecode for the worker identification scheme. This field provides a concise label for reports, dashboards, and HR data views.
WorkerIDLongName	String		The full descriptive name of the code for the worker identification scheme. This field provides the complete label that appears in HR and workforce management documentation.
WorkerGivenName	String		The given (first) name of the worker as recorded in HR and payroll systems. This field is used for identification and display in reports and user interfaces.
WorkerMiddleName	String		The middle name of the worker as recorded in HR systems. This field provides additional identification detail when multiple workers share similar names.
WorkerFamilyName1	String		The primary family (last) name of the worker as recorded in HR and payroll systems. This field is used in official documentation and reports.
WorkerFamilyName2	String		The secondary family (last) name of the worker, if applicable. This field supports organizations where multiple family names are used for legal or cultural reasons.
WorkerFormattedName	String		The full formatted name of the worker that combines given, middle, and family names according to organizational naming conventions. This field provides a standardized display format for reports and records.
RelationshipCode	String		The code that identifies the reporting relationship between the worker and another individual (for example, Supervisor, Manager, or Team Lead). This field defines the hierarchical or functional link between positions.
RelationshipShortName	String		The abbreviated name that corresponds to the reporting relationship code. This field provides a concise label for HR dashboards, analytics, and summary reports.
RelationshipLongName	String		The full descriptive name of the reporting relationship code. This field provides the complete label that is used in HR and organizational structure documentation.
PositionID	String		The Id that represents the position assigned to the worker within the organization. This field links the worker to the specific role or job that is recorded in the HR system.
PositionTitle	String		The official title of the position assigned to the worker. This field is displayed in HR records, directories, and reporting hierarchies.
ItemID	String		The Id that represents the specific work-assignment history report record. This field enables audit tracking and ensures consistency across HR reports and data extracts.

WorkAssignmentHistoryWorkerGroups

The view that returns historical records of worker-group assignments. This view tracks group memberships (for example, departments or teams) that are associated with work assignments across time for analytical and compliance purposes.

View-Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request, while the remaining filters are executed client-side within the connector.

AssociateOID supports the = operator.

For example:

SELECT * FROM WorkAssignmentHistoryWorkerGroups WHERE AssociateOID = 'AOID4J5VGEX1620N'

Columns


Name	Type	References	Description
nameCodeValue	String		The code value that identifies the worker-group name associated with the assignment. This field specifies the formal name of the group to which the worker belongs (for example, Project Team Alpha, Regional Sales Group, or Training Cohort).
nameCodeshortName	String		The abbreviated name that corresponds to the worker-group name code. This field provides a concise label that is used in dashboards, Human Resources (HR) reports, and team summaries.
nameCodelongName	String		The full descriptive name of the code for the worker group. This field provides the complete label that appears in HR documentation, organizational charts, and workforce analytics reports.
GroupCodeValue	String		The code value that identifies the type or classification of the worker group (for example, Functional, Project-Based, or Temporary). This field defines the nature and organizational purpose of the group.
GroupCodeshortName	String		The abbreviated name that corresponds to the type code for the worker group. This field provides a short label for HR dashboards, analytics, and reports.
GroupCodelongName	String		The full descriptive name of the type code for the worker group. This field provides the complete label that is used in HR and workforce management documentation.
itemID	String		The unique identifier (Id) that represents the individual worker-group record within the assignment history. This Id enables tracking and auditing of group memberships over time.
AssociateOID	String	Workers.AssociateOID	The Id that represents the associate to whom this worker-group record belongs. This field links the group membership to the correct worker profile within HR and payroll systems.

WorkerDemographics

The view that returns demographic information for each worker in the organization. This view includes attributes such as age range, gender, ethnicity, and marital status. This view supports diversity analytics, workforce planning, and compliance reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the AssociateOID column and '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM WorkerDemographics WHERE AssociateOID = 'G3349PZGBADQY8H7'

The rest of the filter is executed client-side within the connector.

Columns


Name	Type	References	Description
AssociateOID [KEY]	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate whose demographic information is being captured. This Id links the record to the correct worker profile within Human Resources (HR) and payroll systems.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker within the organization's systems. This field ensures consistency across HR, payroll, and compliance reporting processes.
GivenName	String		The given (first) name of the worker as recorded in HR and payroll systems. This field is used for identification and formal documentation.
FamilyName	String		The family (last) name of the worker as recorded in HR and payroll systems. This field is used for official identification and reporting.
AddressCode	String		The code that identifies the worker's primary address record. This field links address details to the worker's demographic profile.
AddressShortName	String		The abbreviated name or label for the worker's address record. This field provides a concise display for reports and user interfaces.
AddressLineOne	String		The first line of the worker's street address. This field contains the primary physical address information.
CityName	String		The name of the city where the worker's primary address is located. This field is used in mailing, reporting, and regional compliance tracking.
CountrySubdivisionLevelCode	String		The code that identifies the subdivision or region within a country (for example, State, Province, or Territory). This field supports localized reporting and address validation.
CountrySubdivisionType	String		The type of subdivision that corresponds to the country subdivision code. This field defines the level of regional categorization used in the address (for example, State, or Province).
CountrySubdivisionShortName	String		The abbreviated name of the subdivision that is associated with the worker's address. This field provides a short label for HR and compliance reports.
AddressCountryCode	String		The international country code that identifies the country of the worker's address (for example, US, CA, or UK). This field ensures proper regional classification in HR systems.
AddressPostalCode	String		The postal or ZIP code that corresponds to the worker's address. This field supports mailing, geographic reporting, and data validation.
CommunicationLandlines	String		The landline-telephone contact details that are associated with the worker's demographic record. This field provides the main or alternate landline numbers for communication purposes.
CommunicationMobiles	String		The mobile-telephone contact details that are associated with the worker's demographic record. This field stores the mobile numbers used for direct communication and notifications.
CommunicationFaxes	String		The fax numbers that are associated with the worker's demographic record. This field stores work or personal fax details used for documentation exchange.
CommunicationPagers	String		The pager numbers that are associated with the worker's demographic record. This field supports legacy or specialized communication systems still in use in some organizations.
CommunicationEmails	String		The personal email addresses that are associated with the worker's demographic record. This field stores contact details used for personal or HR correspondence.
GenderCode	String		The code that identifies the worker's gender as recorded in HR systems (for example, Male, Female, or Non-Binary). This field is used for reporting and compliance purposes.
GenderCodeShortName	String		The abbreviated name that corresponds to the worker's gender code. This field provides a concise label for dashboards and reports.
MaritalStatusCode	String		The code that identifies the worker's marital status (for example, Single, Married, or Divorced). This field is used for benefits, tax, and compliance reporting.
MaritalStatusShortName	String		The abbreviated name that corresponds to the marital status code. This field provides a short label for HR and payroll reports.
DisabledIndicatior	Boolean		The indicator that specifies whether the worker has self-identified as having a disability. This field is used for diversity, equity, and inclusion reporting.
BirthName	String		The worker's legal birth name as recorded in HR systems. This field is used for background verification and compliance documentation.
OtherPersonalAddresses	String		Additional personal addresses that are associated with the worker. This field captures secondary residences or mailing addresses for correspondence.
RaceCodeIdentificationMethodCode	String		The code that identifies the method that is used to determine or report the worker's race (for example, Self-Identified or Observation). This field is used for compliance and diversity tracking.
RaceCodeIdentificationMethodShortName	String		The abbreviated name that corresponds to the code for the raceiidentification method. This field provides a short label for HR and compliance reports.
RaceCodeShortName	String		The abbreviated name that corresponds to the worker's race code. This field provides a concise display for HR dashboards and compliance summaries.
RaceCode	String		The code that identifies the worker's race as defined by organizational or regulatory standards. This field supports demographic and diversity reporting requirements.
HireDate	Date		The date when the worker was officially hired. This field is used for seniority tracking, benefits eligibility, and reporting purposes.
WorkerStatusCode	String		The code that identifies the worker's current employment status (for example, Active, Terminated, or Leave of Absence). This field defines the worker's standing within HR and payroll systems.
BusinessCommunicationLandlines	String		The landline numbers that are associated with the worker's business contact details. This field supports work-related communication tracking.
BusinessCommunicationMobiles	String		The mobile numbers that are associated with the worker's business contact details. This field supports mobile communication for business use.
BusinessCommunicationFaxes	String		The fax numbers that are associated with the worker's business contact details. This field supports document exchange and business communication tracking.
BusinessCommunicationEmails	String		The business email addresses that are associated with the worker's HR record. This field is used for organizational correspondence and identity verification.
BusinessCommunicationPagers	String		The pager numbers that are associated with the worker's business-contact details. This field supports legacy or specialized internal communication systems.
WorkAssignments	String		The set of work assignment records that are associated with the worker's demographic record. This field links demographic details to job and organizational assignments for consolidated HR reporting.

WorkersBusinessCommunicationEmails

The view that returns business-email contact information for workers. This view includes primary and secondary email addresses that are used for company communication and identity verification.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersBusinessCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersBusinessCommunicationEmails WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersBusinessCommunicationEmails WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate within the Human Resources (HR) system. This Id links the email communication record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker to whom the email address belongs. This field ensures consistent association across payroll, compliance, and communication records.
EmailUri	String		The complete email address that is used for business communication. This field supports internal correspondence, HR notifications, and identity verification.
ItemID	String		The Id that uniquely identifies this email record. This Id allows tracking of historical changes to the worker's contact information.
NameCode	String		The code that categorizes the purpose or type of business email (for example, Work, Alternate Work, or Departmental). This field supports structured communication management.
NameCodeLongName	String		The full descriptive name of the business-email code. This field provides the complete label that appears in HR documentation and directory listings.
NameCodeShortName	String		The abbreviated name that corresponds to the business-email code. This field provides a concise label for HR dashboards and communication reports.
NotificationIndicator	Boolean		The indicator that specifies whether this email address is used for automated HR notifications (for example, pay statements, onboarding updates, or benefits alerts).
AsOfDate	Date		The date that defines when this email information became effective. This field supports audit history, reporting, and time-based data validation.

WorkersBusinessCommunicationFaxes

The view that returns business fax numbers that are associated with worker profiles. This view maintains legacy fax-communication data for administrative and compliance use.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersBusinessCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersBusinessCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersBusinessCommunicationFaxes WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the fax communication record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker to whom the fax number belongs. This field ensures consistent association across payroll, HR, and communication records.
Access	String		The access type that defines how the fax line can be used (for example, Internal, External, or Restricted). This field supports secure communication control and compliance tracking.
AreaDialing	String		The area code that is used for the worker's business fax number. This field supports regional identification and telecommunication routing.
CountryDialing	String		The country dialing code that is used for the worker's business fax number. This field supports international communication and compliance with global formatting standards.
DialNumber	String		The primary fax number that is associated with the worker's business contact record. This field supports internal communication, document exchange, and external correspondence.
Extension	String		The fax line extension number that routes faxes within an organization. This field supports departmental fax delivery and internal message handling.
FormattedNumber	String		The fully formatted version of the worker's business fax number. This field ensures display consistency across HR systems and communication directories.
ItemID	String		The Id that uniquely identifies the fax record. This Id supports tracking of historical changes and version control for worker contact information.
NameCode	String		The code that categorizes the purpose or type of fax number (for example, Work, Department, or Alternate). This field supports structured contact management in HR systems.
NameCodeLongName	String		The full descriptive name of the type code for the fax number. This field provides the complete label that appears in HR documentation and communication reports.
NameCodeShortName	String		The abbreviated name that corresponds to the type code for the fax number type. This field provides a concise label for dashboards, HR reports, and analytics.
NotificationIndicator	Boolean		The indicator that specifies whether this fax number is used for automated HR notifications or document transmissions (for example, compliance forms, payroll updates, or policy notices, and so on).
AsOfDate	Date		The date that defines when this fax information became effective. This field supports historical auditing, reporting, and time-based data validation.

WorkersBusinessCommunicationLandlines

The view that returns business landline contact information for workers. This view lists office phone extensions and mainline numbers for Human Resources (HR) and directory reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersBusinessCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersBusinessCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersBusinessCommunicationLandlines WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the landline communication record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker to whom the business landline number belongs. This field ensures consistent reference across HR, payroll, and communication systems.
Access	String		The access type that defines how the landline can be used (for example, Internal, External, or Restricted). This field supports communication control and access security.
AreaDialing	String		The area dialing code that is used for the worker's business landline number. This field supports regional identification and proper telecommunication routing.
CountryDialing	String		The country dialing code that is used for the worker's business landline number. This field ensures compliance with international dialing formats and supports global workforce communication.
DialNumber	String		The primary landline number that is associated with the worker's business contact record. This field supports internal communication, external correspondence, and office directory listings.
Extension	String		The landline extension number that routes calls within the organization. This field supports departmental call management and internal routing.
FormattedNumber	String		The fully formatted version of the worker's business landline number. This field ensures consistency in how phone numbers are displayed across HR systems and employee directories.
ItemID	String		The Id that uniquely identifies the business landline record. This Id supports tracking, version control, and auditing of communication data changes.
NameCode	String		The code that categorizes the purpose or type of landline number (for example, Work, Department, or Alternate). This field supports structured communication management in HR systems.
NameCodeLongName	String		The full descriptive name of the type code for the business landline. This field provides the complete label that appears in HR documentation and reports.
NameCodeShortName	String		The abbreviated name that corresponds to the type code for the business landline. This field provides a concise label for dashboards, analytics, and HR communication summaries.
NotificationIndicator	Boolean		The indicator that specifies whether this landline number is used for automated HR notifications or business communication alerts (for example, compliance reminders, payroll updates, or emergency calls).
AsOfDate	Date		The date that defines when this business landline information became effective. This field supports time-based reporting, audit history, and HR data validation.

WorkersBusinessCommunicationMobiles

The view that returns business mobile-phone contact data for workers. This view captures mobile numbers that are linked to corporate communication systems and used for workforce contact management.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersBusinessCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersBusinessCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersBusinessCommunicationMobiles WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the mobile communication record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker to whom the business mobile number belongs. This field ensures consistent reference across HR, payroll, and communication systems.
Access	String		The access type that defines how the mobile number can be used (for example, Internal, External, or Restricted). This field supports communication permissions and corporate access controls.
AreaDialing	String		The area dialing code that is used for the worker's business mobile number. This field supports regional identification and accurate call routing.
CountryDialing	String		The country dialing code that is used for the worker's business mobile number. This field ensures compliance with international dialing standards and supports global workforce communication.
DialNumber	String		The primary mobile number that is associated with the worker's business contact record. This field supports official communication, remote accessibility, and identity verification.
Extension	String		The mobile extension number that is assigned for routing or secondary contact purposes. This field supports internal call management and device linking within HR systems.
FormattedNumber	String		The fully formatted version of the worker's business mobile number. This field ensures display consistency across HR, payroll, and contact management systems.
ItemID	String		The Id that uniquely identifies the business mobile record. This Id supports version control, auditing, and traceability of contact information changes.
NameCode	String		The code that categorizes the purpose or type of mobile number (for example, Work, Department, or Alternate). This field supports structured communication classification in HR systems.
NameCodeLongName	String		The full descriptive name of the type code for the mobile number. This field provides the complete label that appears in HR documentation and communication reports.
NameCodeShortName	String		The abbreviated name that corresponds to the type code for the mobile number. This field provides a concise label for dashboards, analytics, and HR summaries.
NotificationIndicator	Boolean		The indicator that specifies whether this mobile number is used for HR notifications or alerts (for example, schedule changes, compliance notices, or system messages).
AsOfDate	Date		The date that defines when this mobile-number information became effective. This field supports time-based reporting, auditing, and data validation across HR systems.

WorkersBusinessCommunicationPagers

The view that returns business-pager contact data for workers. This view preserves historical or legacy pager records that are used for on-call or field communication tracking.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersBusinessCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersBusinessCommunicationPagers WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersBusinessCommunicationPagers WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the pager communication record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker to whom the pager number belongs. This field ensures consistent reference across HR, payroll, and communication systems.
Access	String		The access type that defines how the pager number can be used (for example, Internal, External, or Restricted). This field supports communication control and access security within HR systems.
AreaDialing	String		The area dialing code that is used for the worker's business pager number. This field supports regional identification and routing for communication management.
CountryDialing	String		The country dialing code that is used for the worker's business pager number. This field ensures international dialing compliance and supports communication across geographic regions.
DialNumber	String		The primary pager number that is associated with the worker's business contact record. This field supports critical notifications, operational alerts, and emergency communication.
Extension	String		The pager extension number that is assigned for routing or departmental paging. This field supports internal communication workflows and targeted notifications.
FormattedNumber	String		The fully formatted version of the worker's business pager number. This field ensures uniform display across HR systems and communication directories.
ItemID	String		The Id that uniquely identifies the business pager record. This Id supports version control, auditing, and historical tracking of contact information.
NameCode	String		The code that categorizes the purpose or type of pager number (for example, Work, Department, or Alternate). This field supports structured communication management in HR systems.
NameCodeLongName	String		The full descriptive name of the type code for the pager number. This field provides the complete label that appears in HR documentation and communication directories.
NameCodeShortName	String		The abbreviated name that corresponds to the type code of the pager number. This field provides a concise label for dashboards, analytics, and HR communication summaries.
NotificationIndicator	Boolean		The indicator that specifies whether this pager number is used for automated HR or operational notifications (for example, critical alerts, schedule changes, or safety messages, and so on).
AsOfDate	Date		The date that defines when this pager information became effective. This field supports time-based auditing, compliance validation, and HR record accuracy.

WorkersLeaves

Leaves for an employee.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the AssociateOID column and '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM WorkersLeaves WHERE AssociateOID = 'G3349PZGBADQY8H7'

The rest of the filter is executed client-side within the connector.

Columns


Name	Type	References	Description
LeaveAbsenceStartDate	Date
LeaveAbsenceExpectedEndDate	Date
LeaveAbsenceTypeCode	String
LeaveAbsencePaymentStatus	String
LeaveReturnStatusCode	String
AssociateOID	String	Workers.AssociateOID

WorkersPersonBirthNamePreferredSalutations

The view that returns preferred salutation information that is associated with each worker's birth name. This view standardizes greeting formats (for example, Mr., Ms., or Dr.), which are used in formal Human Resources (HR) and correspondence records.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the preferred salutation record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker for whom the preferred salutation applies. This field ensures consistent linkage across HR, payroll, and personal identification data.
SalutationCode	String		The code that represents the worker's preferred salutation (for example, Mr., Ms., Dr.). This field standardizes naming conventions across HR and business correspondence systems.
SalutationLongName	String		The full descriptive name of the preferred salutation code. This field provides the complete form that appears in formal documentation and communication outputs.
SalutationShortName	String		The abbreviated form of the preferred salutation code. This field provides a concise version for HR interfaces and summary views.
SequenceNumber	Integer		The numeric value that defines the display or processing order of the preferred salutations. This field supports sequencing for workers with multiple valid salutations.
TypeCode	String		The code that categorizes the type of salutation (for example, Birth Name, Legal Name, or Preferred Name). This field supports structured naming classification in HR systems.
TypeCodeLongName	String		The full descriptive name of the type code of the salutation. This field provides the detailed label that appears in HR documentation and data exports.
TypeCodeShortName	String		The abbreviated name that corresponds to the type code of the salutation. This field provides a compact label for internal HR and system displays.
AsOfDate	Date		The date that defines when this preferred salutation record became effective. This field supports historical tracking, auditing, and time-based HR data validation.

WorkersPersonBirthNameTitleAffixCodes

The view that returns title affix codes for worker birth names (for example, Jr., Sr., or III). This view ensures legal name accuracy and consistent representation of personal Ids across Human Resources (HR) and payroll systems.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the title affix record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose birth name includes a title affix. This field ensures proper linkage between the worker record and naming attributes in HR systems.
AffixCode	String		The code that represents the title affix associated with the worker's birth name (for example, Dr., Sir, Lady). This field standardizes naming titles used in formal and regulatory documentation.
AffixCodeLongName	String		The full descriptive name of the code for the title affix. This field provides the complete title as it appears in legal or formal HR records.
AffixCodeShortName	String		The abbreviated form of the code for the title affix. This field supports compact display in HR systems, reports, and interfaces.
SequenceNumber	Integer		The numeric value that determines the display or processing order when multiple title affixes are associated with a single worker. This field ensures proper sequencing in HR and compliance records.
AsOfDate	Date		The date that defines when this title-affix information became effective. This field supports time-based auditing, version control, and regulatory compliance tracking within HR systems.

WorkersPersonBirthNameTitlePrefixCodes

The view that returns title prefix codes for worker birth names (for example, Mr., Mrs., or Dr). This view provides standardized title data that is used in employee identification and official reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the title prefix record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose birth name includes a title prefix. This field ensures accurate linkage between the worker's legal record and personal identification data in HR systems.
PrefixCode	String		The code that represents the title prefix associated with the worker's birth name (for example, Mr., Mrs., Ms., Dr.). This field standardizes naming prefixes across HR records and correspondence templates.
PrefixCodeLongName	String		The full descriptive name of the code for the title prefix. This field provides the complete version of the prefix for use in formal HR documents and reporting outputs.
PrefixCodeShortName	String		The abbreviated form of the code for the title prefix. This field supports compact display in HR user interfaces and communication systems.
SequenceNumber	Integer		The numeric value that defines the display or processing order of multiple prefixes that are associated with a single worker. This field supports sequencing in HR data and record presentation.
AsOfDate	Date		The date that defines when this title-prefix record became effective. This field supports time-based version control, auditing, and compliance management for HR data accuracy.

WorkersPersonGovernmentIDs

The view that returns government identification data for each worker. This view includes identifiers such as Social Security Numbers, Tax Ids, or national identification codes. It supports verification, payroll compliance, and reporting to government agencies.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonGovernmentIDs WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonGovernmentIDs WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonGovernmentIDs WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the government-issued identification record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker associated with the government-issued identification document. This field ensures consistent linkage across HR, payroll, and compliance systems.
CountryCode	String		The code that identifies the country that issued the government identification document (for example, US, CA, or UK). This field supports jurisdictional validation and compliance reporting.
ExpirationDate	Date		The date on which the government identification document expires. This field supports compliance tracking, revalidation workflows, and regulatory audits.
IdValue	String		The alphanumeric value of the worker's government-issued identification (for example, a passport number, national ID, or driver's license number). This field is used to verify legal eligibility for employment.
ItemID	String		The Id that uniquely identifies this government-identification record. This field supports version control, historical tracking, and HR compliance documentation.
NameCode	String		The code that classifies the type of government identification (for example, Passport, Driver's License, or Social Security Number). This field supports structured document management and HR verification processes.
NameCodeLongName	String		The full descriptive name of the type code for the government identification. This field provides the complete label that appears in HR documentation and compliance exports.
NameCodeShortName	String		The abbreviated name that corresponds to the type code of the government identification. This field supports compact display in HR dashboards, forms, and reports.
StatusCode	String		The code that represents the current status of the government identification (for example, active, expired, or pending verification). This field supports document lifecycle tracking in HR systems.
StatusCodeEffectiveDate	Date		The date that defines when the current identification status became effective. This field supports compliance validation and historical reporting.
StatusCodeLongName	String		The full descriptive name of the government-identification status code. This field provides a human-readable label that appears in HR records and audits.
StatusCodeShortName	String		The abbreviated name that corresponds to the government-identification status code. This field supports simplified reference in HR reports and user interfaces.
AsOfDate	Date		The date that defines when this government-identification record became effective. This field supports version control, auditing, and historical accuracy in HR data management.

WorkersPersonLegalNamePreferredSalutations

The view that returns preferred salutations that are associated with each worker's legal name. This view standardizes how names are displayed in Human Resources (HR) documents, correspondence, and system-generated communications.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the preferred salutation record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose legal name includes a preferred salutation. This field ensures proper linkage between the worker's legal naming records and HR systems.
SalutationCode	String		The code that represents the worker's preferred salutation for the legal name (for example, Mr., Ms., Dr.). This field standardizes title formatting across HR, payroll, and correspondence systems.
SalutationCodeLongName	String		The full descriptive name of the code for the preferred salutation. This field provides the complete form of the salutation for use in formal HR documentation and communication templates.
SalutationCodeShortName	String		The abbreviated form of the code for the preferred salutation. This field supports concise display in HR dashboards, user interfaces, and data exports.
SequenceNumber	Integer		The numeric value that defines the display or processing order of multiple salutations associated with a single worker. This field supports sequencing in HR systems and formal record presentation.
TypeCode	String		The code that categorizes the salutation type (for example, Legal, Preferred, or Birth Name). This field supports structured classification of naming conventions within HR records.
TypeCodeLongName	String		The full descriptive name of salutation type code. This field provides the detailed label that appears in HR documentation and exports.
TypeCodeShortName	String		The abbreviated name that corresponds to the salutation type code. This field supports compact labeling for HR dashboards and record displays.
AsOfDate	Date		The date that defines when this preferred salutation record became effective. This field supports time-based version control, auditing, and HR data accuracy.

WorkersPersonLegalNameTitleAffixCodes

The view that returns title affix codes associated with each worker's legal name (for example, Jr., Sr., or III). This view ensures consistent use of legal name suffixes across Human Resources (HR) and payroll records.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the title affix record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose legal name includes a title affix. This field ensures consistent linkage between legal naming data and HR records.
AffixCode	String		The code that represents the title affix associated with the worker's legal name (for example, PhD, Esq., or MD). This field standardizes the use of post-nominal or honorific titles across HR and official correspondence systems.
AffixCodeLongName	String		The full descriptive name of the title-affix code. This field provides the complete label as it appears in formal HR documentation and government reporting outputs.
AffixCodeShortName	String		The abbreviated version of the title-affix code. This field supports compact display in HR dashboards, data exports, and personnel management systems.
SequenceNumber	Integer		The numeric value that defines the display or processing order of multiple title affixes associated with a single worker. This field ensures correct sequencing and readability in HR systems and reports.
AsOfDate	Date		The date that defines when this title-affix record became effective. This field supports HR auditing, version control, and historical data tracking for compliance purposes.

WorkersPersonLegalNameTitlePrefixCodes

The view that returns title prefix codes that are associated with each worker's legal name (for example, Mr., Mrs., or Dr). This view supports proper formatting of names in official Human Resources (HR) and payroll documentation.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the title-prefix record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose legal name includes a title prefix. This field ensures consistent linkage between the worker's legal naming information and HR records.
AffixCode	String		The code that represents the title prefix associated with the worker's legal name (for example, Mr., Mrs., Ms., Dr.). This field standardizes name prefixes across HR systems, correspondence templates, and formal documentation.
AffixCodeLongName	String		The full descriptive name of the title-prefix code. This field provides the complete form of the prefix as it appears in official HR documentation and communication outputs.
AffixCodeShortName	String		The abbreviated version of the title-prefix code. This field supports compact display in HR dashboards, data exports, and internal system interfaces.
SequenceNumber	Integer		The numeric value that defines the display or processing order of multiple prefixes that are associated with a single worker. This field supports sequencing and formatting consistency across HR systems.
AsOfDate	Date		The date that defines when this title-prefix record became effective. This field supports auditing, version control, and compliance tracking for HR data accuracy.

WorkersPersonMilitaryClassificationCodes

The view that returns military classification codes for workers who have served or are serving in the military. This view supports compliance reporting and veteran status tracking for workforce diversity and government reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the military classification record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose record includes a military classification. This field ensures consistent linkage between HR data and government reporting requirements.
CodeValue	String		The code that represents the worker's military classification (for example, Active Duty Wartime or Campaign Badge Veteran, Recently Separated Veteran, or Armed Forces Service Medal Veteran). This field standardizes classification data for HR reporting and compliance tracking.
LongName	String		The full descriptive name of the military classification code. This field provides the complete label that appears in HR reports, compliance documentation, and federal filings.
ShortName	String		The abbreviated version of the military classification code. This field supports concise display in HR dashboards, employee summaries, and data exports.
AsOfDate	Date		The date that defines when this military classification record became effective. This field supports version control, auditing, and compliance verification for HR and government reporting.

WorkersPhotoLinks

The view that returns hyperlink references to worker photos that are stored within ADP systems. This view allows applications and reports to reference image assets without embedding the image data directly.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPhotoLinks WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPhotoLinks WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPhotoLinks WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the photo link record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker associated with the photo link. This field ensures consistent linkage between HR records and digital media references.
CanonicalUri	String		The canonical uniform resource identifier (URI) that defines the permanent, preferred reference location for the worker's photo. This field ensures that HR systems and external integrations consistently reference the same image asset.
EncType	String		The encoding type that specifies the format that is used for the worker's photo data (for example, multipart/form-data or base64). This field supports secure file handling and consistent data transmission.
Href	String		The hyperlink reference (HREF) that provides the direct path or endpoint for accessing the worker's photo. This field enables HR systems to retrieve or display the image dynamically.
MediaType	String		The media type that defines the format of the photo file (for example, image/jpeg, or image/png). This field ensures compatibility across HR applications, portals, and downstream systems.
Method	String		The HTTP method that is used to interact with the photo resource (for example, GET, POST, or PUT). This field supports standardized integration behavior between HR and external systems.
PayLoadArguments	String		The arguments or parameters that are required to execute the method defined for the photo link. This field supports secure API interaction and automated image management workflows.
Rel	String		The relationship type that defines how the linked-photo resource relates to the worker record (for example, self, edit, or alternate). This field supports structured linkage and API documentation standards.
Schema	String		The schema that defines the data structure or format for the linked-photo resource. This field supports validation, data integrity, and HR integration consistency.
TargetSchema	String		The schema that is applied to the destination system or endpoint where the photo link resolves. This field ensures format compatibility between HR systems and external integrations.
Title	String		The title or descriptive label assigned to the photo link. This field supports human-readable identification within HR dashboards, reports, and user interfaces.
AsOfDate	Date		The date that defines when this photo-link record became effective. This field supports version control, auditing, and compliance tracking for HR data accuracy.

WorkersPhotos

The view that returns worker photos that are stored in ADP. This view provides image data that is associated with worker profiles for use in identification, security systems, and Human Resources (HR) applications.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersPhotos WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersPhotos WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersPhotos WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the HR system. This Id links the worker's photo record to the correct HR profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker associated with the stored photo. This field ensures consistent linkage between the worker's image and personal record across HR systems.
ItemID	String		The Id that uniquely identifies the specific photo record. This field supports version control, auditing, and tracking of multiple image instances associated with a single worker.
Links	String		The collection of hyperlinks that provide access to the worker's photo resources (for example, view, edit, or download). This field supports integration with HR portals and external systems.
NameCode	String		The code that categorizes the type or purpose of the worker's photo (for example, Badge, Profile, or Official). This field supports structured data management within HR systems.
NameCodeLongName	String		The full descriptive name of the photo type code. This field provides the complete label that appears in HR reports, documentation, and data exports.
NameCodeShortName	String		The abbreviated name that corresponds to the photo type code. This field supports compact display in HR dashboards, forms, and user interfaces.
AsOfDate	Date		The date that defines when this photo record became effective. This field supports time-based version control, auditing, and HR compliance tracking.

WorkersWorkAssignmentReportsTo

The view that returns reporting relationships for worker assignments. This view identifies each associate's direct manager or supervisor and supports organizational hierarchy reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentReportsTo WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentReportsTo WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentReportsTo WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate in the Human Resources (HR) system. This Id links the reporting relationship record to the correct worker profile.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose reporting relationship is being defined. This field ensures accurate linkage between the worker's record and supervisory hierarchy data.
ItemID	String		The Id that uniquely identifies the reporting relationship record. This field supports version control, auditing, and HR reporting structure management.
PositionID	String		The Id that identifies the worker's current position within the organization. This field supports organizational hierarchy mapping and HR role assignment tracking.
ReportsToAssociateOID	String		The associate Id that identifies the manager or supervisor to whom the worker reports. This field ensures accurate linkage between reporting relationships and leadership structures within HR systems.
ReportsToWorkerID	String		The worker Id that identifies the supervisor or manager in the reporting relationship. This field supports consistency between HR, payroll, and organizational data.
WorkerIDSchemeCode	String		The code that identifies the scheme or standard under which the worker Id is assigned (for example, ADP Worker Schema or Internal HR Schema). This field supports data governance and integration consistency.
WorkerIDSchemeCodeShortName	String		The abbreviated name that corresponds to the scheme code for the worker Id. This field provides a compact label for HR reports and technical data exports.
ReportsToWorkerNameFormattedName	String		The formatted name of the supervisor or manager in the reporting relationship (for example, Jane Q. Smith). This field supports human-readable hierarchy reporting and HR analytics.
AsOfDate	Date		The date that defines when this reporting relationship record became effective. This field supports historical tracking, auditing, and HR compliance management.

WorkersWorkAssignmentsAssignedOrganizationalUnits

The view that returns the organizational units that are assigned to each worker's work assignment. This view links employees to departments or divisions for workforce management and financial reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate who is linked to the assigned organizational unit. This field supports Human Resources (HR) tracking, payroll alignment, and workforce reporting.
WorkerID	String	Workers.WorkerID	The Id that represents the worker whose assignment includes the specified organizational unit. This field supports HR personnel management and organizational mapping.
ItemID	String		The unique Id that represents the assigned organizational unit record. This field supports HR data integrity and assignment history tracking.
NameCode	String		The code that identifies the name or label for the assigned organizational unit (for example, Department A, Sales, or Division 1). This field supports HR structure mapping and reporting.
NameCodeLongName	String		The full descriptive name of the assigned organizational unit. This field provides clarity in HR documentation, reporting, and analytics.
NameCodeShortName	String		The abbreviated name that corresponds to the organizational unit. This field supports compact HR displays, payroll reports, and data exports.
TypeCode	String		The code that identifies the type or classification of the assigned organizational unit (for example, Department, Division, or Cost Center). This field supports HR categorization and payroll organization.
TypeCodeLongName	String		The full descriptive name of the type code for the organizational unit. This field provides clear context in HR reporting and system configuration.
TypeCodeShortName	String		The abbreviated name that corresponds to the type code for the organizational unit. This field supports compact HR reporting and consistent data exports.
AsOfDate	Date		The date that defines when the assignment to the organizational unit is effective. This field supports HR historical tracking, payroll synchronization, and compliance reporting.

WorkersWorkAssignmentsAssignedWorkLocations

The view that returns assigned work location data for worker assignments. This view tracks where employees perform their duties, supporting payroll tax jurisdiction and location-based reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the assigned work location. This field supports Human Resources (HR) record management, payroll processing, and location-based reporting.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assignment includes this work location. This field ensures accurate HR and payroll association with location-specific data.
AddressAttentionOfName	String		The name of the individual or department that should receive correspondence at this address. This field supports HR documentation, worksite routing, and organizational communication.
AddressBlockName	String		The name of the neighborhood or block where the work location is situated. This field supports HR site mapping and regional analysis.
AddressBuildingName	String		The name of the building where the worker is assigned. This field supports HR workplace identification and facility tracking.
AddressBuildingNumber	String		The number assigned to the building where the worker performs duties. This field supports HR address validation and location management.
AddressCareOfName	String		The name of the person or department designated to receive communications on behalf of the worker or organization. This field supports HR correspondence and logistical accuracy.
AddressCityName	String		The city where the assigned work location is situated. This field supports HR reporting, payroll tax jurisdiction, and regulatory compliance.
AddressCountryCode	String		The code that identifies the country of the assigned work location (for example, US, CA, or MX). This field supports HR international operations and payroll taxation rules.
AddressCountrySubdivisionLevel1CodeValue	String		The code that identifies the primary administrative division of the country (for example, state or province). This field supports HR regional compliance and location reporting.
AddressCountrySubdivisionLevel1LongName	String		The full descriptive name of the primary country subdivision (for example, California or Ontario). This field provides context for HR documentation and payroll reporting.
AddressCountrySubdivisionLevel1ShortName	String		The abbreviated name of the primary country subdivision. This field supports compact HR and payroll reporting.
AddressCountrySubdivisionLevel1SubdivisionType	String		The type of administrative division represented by the subdivision code (for example, State, Province, or Territory). This field supports HR and payroll classification.
AddressCountrySubdivisionLevel2CodeValue	String		The code that identifies the secondary subdivision within the country (for example, county or district). This field supports HR site management and regional reporting.
AddressCountrySubdivisionLevel2LongName	String		The full descriptive name of the secondary subdivision. This field supports HR address clarity and local compliance reporting.
AddressCountrySubdivisionLevel2ShortName	String		The abbreviated name of the secondary subdivision. This field supports compact HR recordkeeping and address display.
AddressCountrySubdivisionLevel2SubdivisionType	String		The type of administrative level represented by the secondary subdivision (for example, County, District, or Municipality). This field supports HR and payroll classification.
AddressDeliveryPoint	String		The delivery point designation within the address (for example, a mail stop or internal routing code). This field supports HR correspondence accuracy and logistics management.
AddressDoor	String		The specific door number or identifier used for the work location. This field supports HR facility access tracking and mail delivery accuracy.
AddressFloor	String		The floor number or designation where the worker's office or workspace is located. This field supports HR workspace management and emergency planning.
AddressGeoCoordinateLatitude	Integer		The latitude coordinate of the assigned work location. This field supports HR mapping, safety planning, and compliance with geographic regulations.
AddressGeoCoordinateLongitude	Integer		The longitude coordinate of the assigned work location. This field supports HR mapping, reporting, and compliance management.
AddressLineFive	String		The fifth line of the street address used to provide extended address information. This field supports HR address precision and formatting for international locations.
AddressLineFour	String		The fourth line of the street address used for supplemental information. This field supports HR mail routing and location identification.
AddressLineOne	String		The first line of the street address. This field typically contains the primary building number and street name and supports HR record accuracy and postal compliance.
AddressLineThree	String		The third line of the street address. This field supports HR documentation for extended address details such as suite or unit numbers.
AddressLineTwo	String		The second line of the street address used for additional address elements (for example, floor or department). This field supports HR address completeness and verification.
AddressNameCode	String		The code that identifies the name of the assigned address record. This field supports HR and payroll reference linking for address records.
AddressNameCodeLongName	String		The full descriptive name of the address code. This field supports HR data clarity and location-based reporting.
AddressNameCodeShortName	String		The abbreviated name that corresponds to the address code. This field supports compact HR reporting and system exports.
AddressPlotID	String		The Id that identifies the plot or lot on which the building or facility is located. This field supports HR facility management and geographic recordkeeping.
AddressPostalCode	String		The postal or ZIP code associated with the work location. This field supports HR regional tax assignment and payroll processing.
AddressPostOfficeBox	String		The post office box (PO) number for the work location. This field supports HR mailing address validation and correspondence tracking.
AddressScriptCodeValue	String		The code that identifies the script used in the address representation (for example, Latin, Cyrillic, or Arabic). This field supports HR internationalization and multilingual recordkeeping.
AddressScriptCodeLongName	String		The full descriptive name of the address script code. This field supports HR documentation and data interoperability.
AddressScriptCodeShortName	String		The abbreviated name that corresponds to the address script code. This field supports compact HR and payroll data exports.
AddressStairCase	String		The stair or staircase identifier used within the building address. This field supports HR location identification and safety management.
AddressStreetName	String		The name of the street where the assigned work location is located. This field supports HR address validation and payroll jurisdiction mapping.
AddressStreetTypeCode	String		The code that identifies the type of street (for example, Avenue, Boulevard, or Road). This field supports HR address formatting and standardization.
AddressStreetTypeCodeLongName	String		The full descriptive name of the type code for the street. This field supports HR address validation and documentation.
AddressStreetTypeCodeShortName	String		The abbreviated name that corresponds to the type code for the street. This field supports compact HR address display.
addressUnit	String		The unit number, apartment, or suite designation for the work location. This field supports HR workspace assignment and address completeness.
CommunicationEmails	String		The collection of email addresses associated with the assigned work location. This field supports HR contact routing and facility-level notifications.
CommunicationFaxes	String		The collection of fax numbers associated with the assigned work location. This field supports HR document transmission and business communication.
CommunicationLandlines	String		The collection of landline telephone numbers associated with the assigned work location. This field supports HR and payroll contact reference.
CommunicationMobiles	String		The collection of mobile numbers associated with the assigned work location. This field supports HR emergency communication and accessibility.
CommunicationPagers	String		The collection of pager numbers associated with the assigned work location. This field supports HR legacy communication and internal alerting systems.
ItemID	String		The Id that represents the assigned work-location record. This field supports HR and payroll linkage to location-specific data.
NameCode	String		The code that identifies the name assigned to the work location (for example, Main Office, Warehouse, or HQ North). This field supports HR facility tracking and payroll reporting.
NameCodeLongName	String		The full descriptive name of the work location. This field provides clarity in HR and payroll documentation.
NameCodeShortName	String		The abbreviated name that corresponds to the work location. This field supports compact HR and payroll reporting.
AsOfDate	Date		The date that defines when the assigned work-location record is effective. This field supports HR historical tracking, payroll synchronization, and compliance management.

WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails

The view that returns email contact information that is associated with assigned work locations. This view enables communication with site administrators or location-specific Human Resources (HR) personnel.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the assigned work location's communication email record. This field supports HR communication tracking and organizational reporting.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assigned work location includes this email contact record. This field supports HR correspondence, notification routing, and data synchronization.
EmailUri	String		The email address that is associated with the assigned work location (for example, hr@company.com, manager@branch.org). This field supports HR communication, employee contact management, and facility coordination.
ItemID	String		The Id that represents the specific email record for the assigned work location. This field supports HR data integrity, communication tracking, and system auditing.
NameCode	String		The code that identifies the name or category assigned to the email address (for example, General, Payroll, or Emergency). This field supports structured HR communication management and reporting.
NameCodeLongName	String		The full descriptive name of the email type code. This field provides context for HR reporting, documentation, and audit trails.
NameCodeShortName	String		The abbreviated name that corresponds to the email type code. This field supports compact display in HR dashboards and communication exports.
NotificationIndicator	Boolean		A Boolean value that indicates whether the email address is designated for system-generated or high-priority notifications. This field supports HR alert distribution and compliance messaging.
AsOfDate	Date		The date that defines when the assigned work-location email record became effective. This field supports HR historical tracking, communication auditing, and compliance reporting.

WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes

The view that returns fax communication data that is associated with assigned work locations. This view preserves site-level fax information for administrative or compliance correspondence.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the assigned work location's fax communication record. This field supports Human Resources (HR) correspondence tracking and organizational record management.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assigned work location includes this fax number. This field supports HR contact management, site communication, and historical recordkeeping.
Access	String		The access type or dialing prefix that is required to reach the fax number (for example, 9 for an outside line). This field supports HR telecommunication configuration and compliance tracking.
AreaDialing	String		The area code or regional dialing prefix associated with the fax number. This field supports HR contact standardization and geographic data validation.
CountryDialing	String		The country dialing code for the fax number (for example, 1 for the United States or 44 for the United Kingdom). This field supports HR global communication and international contact compliance.
DialNumber	String		The primary fax number assigned to the work location. This field supports HR communication routing, document delivery, and contact identification.
Extension	String		The internal extension associated with the fax line. This field supports HR routing for large facilities or multi-department locations.
FormattedNumber	String		The fax number that is formatted for readability and standardization (for example, +1 (212) 555-6789). This field supports HR display, document templates, and audit reports.
ItemID	String		The Id that represents the fax record for the assigned work location. This field supports HR data integrity, record versioning, and communication audits.
NameCode	String		The code that identifies the category or purpose of the fax number (for example, Payroll, HR Office, or Recruiting). This field supports structured communication management within HR systems.
NameCodeLongName	String		The full descriptive name of the fax-number category. This field provides clarity for HR documentation and organizational reporting.
NameCodeShortName	String		The abbreviated name that corresponds to the fax-number category. This field supports compact display in HR dashboards and exported reports.
NotificationIndicator	Boolean		A Boolean value that indicates whether the fax number is designated to receive system-generated notifications or automated transmissions. This field supports HR operational alerts and compliance messaging.
AsOfDate	Date		The date that defines when the assigned work-location fax record became effective. This field supports HR historical tracking, auditing, and compliance reporting.

WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines

The view that returns landline phone numbers that are associated with assigned work locations. This view provides fixed-line contact details for Human Resources (HR) and operational communication.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the assigned work location's landline communication record. This field supports HR contact management and location-based reporting.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assigned work location includes this landline number. This field supports HR communication tracking, payroll coordination, and organizational recordkeeping.
Access	String		The access type or dialing prefix that is required to reach the landline number (for example, 9 for an outside line). This field supports HR telecommunication configuration and compliance management.
AreaDialing	String		The area code or regional dialing prefix associated with the landline number. This field supports HR contact standardization and geographic analysis.
CountryDialing	String		The country dialing code for the landline number (for example, 1 for the United States or 44 for the United Kingdom). This field supports HR international communication and compliance tracking.
DialNumber	String		The primary landline telephone number for the assigned work location. This field supports HR communication, departmental coordination, and workforce accessibility.
Extension	String		The internal extension associated with the landline number. This field supports HR call routing within large offices or multi-department facilities.
FormattedNumber	String		The landline number that is formatted for readability and standardization (for example, +1 (617) 555-1234). This field supports HR data validation, document templates, and reporting accuracy.
ItemID	String		The Id that represents the landline communication record for the assigned work location. This field supports HR data integrity, version control, and audit processes.
NameCode	String		The code that identifies the category or type of landline (for example, Main Line, Department, or Security). This field supports structured HR contact organization and reporting.
NameCodeLongName	String		The full descriptive name of the type code for the landline. This field provides context in HR documentation and system reporting.
NameCodeShortName	String		The abbreviated name that corresponds to the type code for the landline. This field supports compact display in HR dashboards and exported datasets.
NotificationIndicator	Boolean		A Boolean value that indicates whether the landline number is designated to receive system notifications or automated messages. This field supports HR communication alerts and internal escalation workflows.
AsOfDate	Date		The date that defines when the assigned work-location landline record became effective. This field supports HR historical tracking, auditing, and compliance management.

WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles

The view that returns mobile phone contact data that is associated with assigned work locations. This view captures mobile communication numbers that are used for coordination and emergency communication.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the assigned work location's mobile communication record. This field supports Human Resources (HR) contact management, field accessibility, and workforce reporting.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assigned work location includes this mobile number. This field supports HR communication routing, emergency response planning, and record accuracy.
Access	String		The access type or dialing prefix that is required to reach the mobile number (for example, 9 for an outside line). This field supports HR telecommunication setup and compliance management.
AreaDialing	String		The area code or regional dialing prefix associated with the mobile number. This field supports HR contact standardization and geographic reporting.
CountryDialing	String		The country dialing code for the mobile number (for example, 1 for the United States or 44 for the United Kingdom). This field supports HR international communication and compliance management.
DialNumber	String		The primary mobile number associated with the assigned work location. This field supports HR communication, employee accessibility, and emergency coordination.
Extension	String		The internal or departmental extension, if applicable, associated with the mobile number. This field supports HR contact routing and organizational structure.
FormattedNumber	String		The mobile number that is formatted for readability and consistency (for example, +1 (646) 555-9012). This field supports HR documentation, system validation, and payroll reporting.
ItemID	String		The Id that represents the mobile communication record for the assigned work location. This field supports HR data integrity, version control, and auditing.
NameCode	String		The code that identifies the category or purpose of the mobile number (for example, Supervisor, Emergency, or Department Contact). This field supports structured HR communication and organizational mapping.
NameCodeLongName	String		The full descriptive name of the category code for the mobile number. This field provides clarity for HR documentation, audit logs, and organizational charts.
NameCodeShortName	String		The abbreviated name that corresponds to the category code for the mobile number. This field supports compact display in HR dashboards and exported reports.
NotificationIndicator	Boolean		A Boolean value that indicates whether the mobile number is designated for system alerts or automated notifications. This field supports HR emergency alerts, compliance messaging, and escalation workflows.
AsOfDate	Date		The date that defines when the assigned work-location mobile record became effective. This field supports HR historical tracking, compliance verification, and system synchronization.

WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers

The view that returns pager contact data that is associated with assigned work locations. This view preserves historical or specialized paging contact records for field or shift-based communication tracking.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the assigned work location's pager communication record. This field supports Human Resources (HR) contact management, emergency communication, and workforce coordination.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assigned work location includes this pager record. This field supports HR communication routing, shift coordination, and employee contact tracking.
Access	String		The access type or dialing prefix that is required to reach the pager number (for example, 9 for an outside line). This field supports HR telecommunication setup and system standardization.
AreaDialing	String		The area code or regional dialing prefix associated with the pager number. This field supports HR contact consistency and regional reporting.
CountryDialing	String		The country dialing code for the pager number (for example, 1 for the United States or 44 for the United Kingdom). This field supports HR international communication and compliance management.
DialNumber	String		The primary pager number assigned to the worker's location. This field supports HR emergency response, on-call coordination, and internal communication workflows.
Extension	String		The internal extension that corresponds to the pager line, if applicable. This field supports HR routing for on-site and facility-based staff.
FormattedNumber	String		The pager number that is formatted for readability and standardization (for example, +1 (303) 555-7788). This field supports HR data validation, documentation, and operational consistency.
ItemID	String		The Id that represents the pager communication record for the assigned work location. This field supports HR data integrity, version control, and audit compliance.
NameCode	String		The code that identifies the purpose or category of the pager number (for example, Maintenance, Security, or Medical Response). This field supports structured HR communication management and role-based routing.
NameCodeLongName	String		The full descriptive name of the category code for the pager. This field provides clarity in HR documentation, operational manuals, and workforce communication systems.
NameCodeShortName	String		The abbreviated name that corresponds to the category code fore the pager. This field supports compact HR display and streamlined data exports.
NotificationIndicator	Boolean		A Boolean value that indicates whether the pager is configured to receive system alerts or critical notifications. This field supports HR emergency alerts, escalation workflows, and operational readiness tracking.
AsOfDate	Date		The date that defines when the assigned work-location pager record became effective. This field supports HR historical tracking, audit compliance, and communication record maintenance.

WorkersWorkAssignmentsHomeOrganizationalUnits

The view that returns home organizational unit data for worker assignments. This view identifies the primary organizational unit that is associated with each worker for payroll allocation and hierarchy reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the home organizational unit record. This field supports Human Resources (HR) reporting, hierarchy management, and workforce alignment.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker assigned to the home organizational unit. This field supports HR recordkeeping, reporting structure validation, and position tracking.
ItemID	String		The Id that represents the specific home organizational-unit entry for the worker. This field supports HR data integrity, version control, and historical audit accuracy.
NameCodeValue	String		The code that identifies the name of the home organizational unit (for example, Corporate Headquarters or Manufacturing Division). This field supports structured HR organization mapping and departmental classification.
NameCodeLongName	String		The full descriptive name of the home organizational-unit code. This field provides clarity in HR documentation, organizational charts, and system reporting.
NameCodeShortName	String		The abbreviated name that corresponds to the home organizational-unit code. This field supports concise HR displays and compact data exports.
TypeCodeValue	String		The code that specifies the type of organizational unit (for example, Department, Division, or Business Segment). This field supports HR structural categorization and workflow routing.
TypeCodeLongName	String		The full descriptive name of the type code for the organizational unit. This field provides clarity for HR structure documentation and reporting.
TypeCodeShortName	String		The abbreviated name that corresponds to the type code for the organizational unit. This field supports space-efficient HR dashboards and export views.
AsOfDate	Date		The date that defines when the home organizational-unit record became effective. This field supports HR historical tracking, audit compliance, and organizational change management.

WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails

The view that returns email communication information for workers' home work locations. This view provides site-level contact details that are used for administrative coordination.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the home work location's email communication record. This field supports Human Resources (HR) contact management, payroll notifications, and system data alignment across associated entities.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose home work location includes this email record. This field supports HR correspondence tracking, personnel verification, and synchronization with organizational reporting systems.
EmailUri	String		The email address that is assigned to the home work location (for example, hrhomeoffice@company.com or region.admin@division.org). This field supports formal business communication, employee notifications, and document routing within HR systems.
ItemID	String		The Id that represents the record entry for the email communication for the home work location. This field supports record versioning, data integrity, and traceability in HR information systems.
NameCode	String		The code that identifies the label or classification assigned to the email address (for example, Payroll, Benefits, or Emergency Contact). This field supports structured HR communication, automation workflows, and integration with organizational directories.
NameCodeLongName	String		The full descriptive name of the code that categorizes the email address. This field supports clarity in HR reporting, employee directories, and compliance documentation.
NameCodeShortName	String		The abbreviated name that corresponds to the email code. This field supports concise display in HR dashboards, exports, and payroll system summaries.
NotificationIndicator	Boolean		A Boolean value that indicates whether the email address is configured to receive automated or critical system notifications. This field supports HR alert management, policy compliance, and employee communication tracking.
AsOfDate	Date		The date that defines when the email record for the home work location became effective. This field supports historical recordkeeping, auditing, and HR compliance tracking for data synchronization across systems.

WorkersWorkAssignmentsHomeWorkLocationCommunicationFaxes

The view that returns fax communication data for workers' home work locations. This view supports Human Resources (HR) and payroll correspondence that requires fax-based communication.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationFaxes WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the home work location's fax communication record. This field supports HR contact management, payroll coordination, and compliance documentation.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose home work location includes this fax record. This field supports HR correspondence tracking, personnel verification, and synchronization with organizational reporting systems.
Access	String		The access code or prefix that is required to place an outbound fax from the home work location. This field supports HR facilities management, telecommunication configurations, and system integration for location-specific dialing rules.
AreaDialing	String		The area code that corresponds to the geographic dialing region for the fax number. This field supports HR record accuracy, telecommunication mapping, and location validation.
CountryDialing	String		The country dialing code that is associated with the fax number for the home work location. This field supports international HR operations, global workforce communication, and compliance with telecommunication standards.
DialNumber	String		The main fax number that is assigned to the home work location. This field supports HR document transmission, payroll form submission, and communication with external agencies.
Extension	String		The fax line extension that is used for specific departments or individuals within the home work location. This field supports HR subdepartment routing and efficient internal communication.
FormattedNumber	String		The fully formatted fax number, including country code, area code, and extension (for example, +1 212 555 0199 ext. 1234). This field supports consistent HR reporting, validation, and integration with automated fax systems.
ItemID	String		The Id that represents the fax communication record for the home work location. This field supports record versioning, data integrity, and traceability in HR and payroll systems.
NameCode	String		The code that identifies the category or label assigned to the fax record (for example, Payroll, Benefits, or Emergency Contact). This field supports structured HR communication, automation workflows, and standardized reporting.
NameCodeLongName	String		The full descriptive name of the fax communication code. This field supports clarity in HR documentation, system exports, and compliance audits.
NameCodeShortName	String		The abbreviated name that corresponds to the fax communication code. This field supports concise display in HR dashboards, forms, and reporting tools.
NotificationIndicator	Boolean		A Boolean value that indicates whether the fax line is designated for automated or critical system notifications. This field supports HR alert routing, communication compliance, and workflow automation.
AsOfDate	Date		The date that defines when the fax record for the home work location became effective. This field supports HR auditing, historical recordkeeping, and synchronization across payroll and compliance systems.

WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines

The view that returns landline communication data for workers' home work locations. This view provides fixed-line contact numbers that are maintained for Human Resources (HR) directory and compliance use.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the landline communication record for the home work location. This field supports HR contact management, payroll coordination, and record synchronization across organizational systems.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose home work location includes this landline record. This field supports HR communication tracking, personnel verification, and cross-system data consistency.
Access	String		The access code that is required to place an outbound call from the home work location. This field supports HR facilities management, telecommunication setup, and enforcement of secure dialing protocols.
AreaDialing	String		The area code that corresponds to the geographic dialing region for the landline number. This field supports HR record accuracy, location validation, and consistency in telecommunication mapping.
CountryDialing	String		The country dialing code that is associated with the landline number for the home work location. This field supports international HR operations, compliance with telecommunication standards, and cross-border communication.
DialNumber	String		The main telephone number that is assigned to the home work location. This field supports HR communication, payroll verification, and employee outreach processes.
Extension	String		The internal phone extension that is assigned to a department or individual within the home work location. This field supports HR routing of calls, departmental communication, and workflow efficiency.
FormattedNumber	String		The fully formatted landline number, including country code, area code, and extension (for example, +1 212 555 0199 ext. 1234). This field supports HR reporting, telecommunication validation, and system integration.
ItemID	String		The Id that represents the landline communication record for the home work location. This field supports data traceability, auditing, and version control within HR and payroll systems.
NameCode	String		The code that identifies the category or label assigned to the landline record (for example, Payroll, Benefits, or Emergency Contact). This field supports structured HR communication, automation workflows, and data classification.
NameCodeLongName	String		The full descriptive name of the code that classifies the landline record. This field supports HR documentation, compliance auditing, and system clarity in reports and exports.
NameCodeShortName	String		The abbreviated name that corresponds to the landline record's code. This field supports concise HR dashboards, summaries, and quick-reference reporting.
NotificationIndicator	Boolean		A Boolean value that indicates whether the landline number is designated to receive automated or emergency notifications. This field supports HR alert routing, policy compliance, and employee communication processes.
AsOfDate	Date		The date that defines when the landline record for the home work location became effective. This field supports HR auditing, historical tracking, and synchronization with payroll and compliance systems.

WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles

The view that returns mobile phone communication data for workers' home work locations. This view supports contact and scheduling coordination for employees based at specific sites.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to mobile communication record for the home work location. This field supports Human Resources (HR) contact management, payroll coordination, and data synchronization across organizational systems.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose home work location includes this mobile record. This field supports HR communication tracking, personnel verification, and cross-system data consistency.
Access	String		The access code that is required to place an outbound mobile call from the home work location. This field supports HR telecommunication setup, facilities management, and secure dialing configuration.
AreaDialing	String		The area code that corresponds to the geographic dialing region for the mobile number. This field supports HR record accuracy, regional workforce validation, and telecommunication mapping.
CountryDialing	String		The country dialing code that is associated with the mobile number for the home work location. This field supports international HR operations, global workforce communication, and compliance with telecommunication standards.
DialNumber	String		The main mobile number that is assigned to the home work location or the associated worker. This field supports HR communication, emergency notifications, and real-time employee contact.
Extension	String		The mobile line extension that is associated with a department or role. This field supports HR routing, departmental coordination, and internal contact structures.
FormattedNumber	String		The fully formatted mobile number, including country code, area code, and extension (for example, +1 415 555 0175 ext. 100). This field supports HR record validation, system integration, and automated communication workflows.
ItemID	String		The Id that represents the mobile communication record for the home work location. This field supports data traceability, auditing, and version control within HR and payroll systems.
NameCode	String		The code that identifies the category or label assigned to the mobile record (for example, Payroll, Benefits, or Emergency Contact). This field supports structured HR communication, automation, and consistent data classification.
NameCodeLongName	String		The full descriptive name of the code that classifies the mobile record. This field supports HR documentation, compliance auditing, and system transparency.
NameCodeShortName	String		The abbreviated name that corresponds to the mobile record's code. This field supports concise HR dashboards, user interfaces, and summary reporting.
NotificationIndicator	Boolean		A Boolean value that indicates whether the mobile number is designated for automated or emergency notifications. This field supports HR alert routing, compliance communication, and employee safety programs.
AsOfDate	Date		The date that defines when the mobile record for the home work location became effective. This field supports HR auditing, historical tracking, and synchronization with payroll and compliance systems.

WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers

The view that returns pager communication data for workers' home work locations. This view retains legacy contact information that can be used in operational or emergency contexts.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the pager communication record for the home work location. This field supports Human Resources (HR) contact management, workforce coordination, and system synchronization across HR platforms.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose home work location includes this pager record. This field supports HR communication tracking, employee verification, and integration across payroll and organizational systems.
Access	String		The access code that is required to initiate a pager message or signal from the home work location. This field supports HR telecommunication setup, facilities management, and secure messaging configurations.
AreaDialing	String		The area code that corresponds to the geographic dialing region for the pager number. This field supports HR record consistency, telecommunication mapping, and location-based validation.
CountryDialing	String		The country dialing code that is associated with the pager number for the home work location. This field supports international HR communication, cross-border employee contact, and compliance with telecommunication standards.
DialNumber	String		The main pager number that is assigned to the home work location or specific worker. This field supports HR communication workflows, real-time notifications, and emergency alert routing.
Extension	String		The pager extension that is assigned to an individual or department within the home work location. This field supports HR routing efficiency, departmental coordination, and communication accuracy.
FormattedNumber	String		The fully formatted pager number, including country code, area code, and extension (for example, +1 312 555 0183 ext. 101). This field supports HR reporting, validation, and integration with automated notification systems.
ItemID	String		The Id that represents the pager communication record for the home work location. This field supports auditing, version tracking, and synchronization across HR and payroll systems.
NameCode	String		The code that identifies the classification or label assigned to the pager record (for example, Payroll, Benefits, or Emergency Contact). This field supports structured HR communication, automation, and categorization of employee contact methods.
NameCodeLongName	String		The full descriptive name of the code that classifies the pager record. This field supports HR reporting, documentation, and data transparency for compliance and recordkeeping.
NameCodeShortName	String		The abbreviated name that corresponds to the pager record's code. This field supports concise HR dashboards, summaries, and system views where space is limited.
NotificationIndicator	Boolean		A Boolean value that indicates whether the pager is designated to receive automated alerts or emergency notifications. This field supports HR alert routing, business continuity processes, and workforce safety programs.
AsOfDate	Date		The date that defines when the pager record for the home work location became effective. This field supports HR historical tracking, auditing, and synchronization with payroll and compliance systems.

WorkersWorkAssignmentsIndustryClassifications

The view that returns industry classification data for worker assignments. This view aligns job functions and departments with industry-standard classification codes that are used in compliance and statistical reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the industry classification record for the work assignment. This field supports Human Resources (HR) data management, compliance tracking, and reporting alignment across organizational systems.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assignment is associated with a specific industry classification. This field supports HR workforce segmentation, analytics, and integration with payroll and compliance systems.
ClassificationCode	String		The code that identifies the industry classification applicable to the worker's assignment. This field supports HR categorization, regulatory compliance, and reporting aligned with standard industry codes.
ClassificationCodeLongName	String		The full descriptive name that corresponds to the industry classification code. This field supports HR documentation, labor analytics, and compliance reporting with detailed classification context.
ClassificationCodeShortName	String		The abbreviated name that represents the industry classification code. This field supports compact HR dashboards, summaries, and other views where concise labeling is required.
ItemID	String		The Id that represents the industry classification record for the worker's assignment. This field supports record traceability, version control, and synchronization across HR and payroll systems.
NameCode	String		The code that identifies the name or label assigned to the industry classification entry (for example, Manufacturing, Retail, or Healthcare). This field supports HR categorization and reporting automation.
NameCodeLongName	String		The full descriptive name associated with the code that classifies the worker's industry assignment. This field supports HR compliance documentation, reporting accuracy, and workforce analytics.
NameCodeShortName	String		The abbreviated name that corresponds to the code that is used to identify the industry classification. This field supports compact HR dashboards and data exports.
AsOfDate	Date		The date that defines when the industry classification record became effective. This field supports HR auditing, historical tracking, and system synchronization for compliance reporting.

WorkersWorkAssignmentsLinks

The view that returns link data that is associated with worker assignments. This view identifies related entities (for example, departments or projects), enabling relational navigation between worker records and organizational structures.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsLinks WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsLinks WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsLinks WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the record for the work-assignment link. This field supports Human Resources (HR) record management, data synchronization, and system-to-system integration.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assignment is linked through this record. This field supports HR communication tracking, relationship mapping, and record consistency across integrated systems.
CanonicalUri	String		The canonical uniform resource identifier (URI) that provides a permanent, system-recognized reference to the work assignment resource. This field supports consistent HR data retrieval and cross-application linking.
EncType	String		The encoding type that is used to specify how the linked resource's data is formatted. This field supports secure data exchange, HR system compatibility, and compliance with integration standards.
Href	String		The hyperlink reference (HREF) that defines the target location of the linked work-assignment resource. This field supports HR system navigation, automated data queries, and integration with external APIs.
MediaType	String		The media type that describes the format of the linked resource (for example, application/json or text/xml). This field supports HR system interoperability and ensures that linked data is processed correctly.
Method	String		The method that is used to interact with the linked resource (for example, GET, POST, PUT, or DELETE). This field supports HR application programming interface (API) operations and data synchronization workflows.
PayLoadArguments	String		The parameters that are passed in the payload when interacting with the linked resource. This field supports HR data exchange, secure system calls, and automation of workflow processes.
Rel	String		The relationship type that defines how the current work-assignment record is related to the linked resource (for example, self, next, or previous). This field supports HR data modeling and relational mapping across systems.
Schema	String		The schema that defines the data structure of the linked resource. This field supports HR integration consistency, system validation, and data governance.
TargetSchema	String		The schema that is targeted by the link when the associated resource is called or retrieved. This field supports HR data exchange, system mapping, and schema-level validation.
Title	String		The title or label that describes the linked work-assignment resource. This field supports HR documentation, user interface display, and accessibility in linked data environments.
AsOfDate	Date		The date that defines when the link record became effective. This field supports HR auditing, historical recordkeeping, and synchronization across integrated systems.

WorkersWorkAssignmentsOccupationalClassifications

The view that returns occupational classification codes for worker assignments. This view categorizes workers by occupation for regulatory compliance, labor reporting, and analytics.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the occupational classification record. This field supports Human Resources (HR) compliance reporting, workforce analytics, and integration with labor market standards.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assignment is associated with the occupational classification. This field supports HR record management, employment tracking, and regulatory reporting alignment.
ClassificationCode	String		The code that represents the occupational classification assigned to the worker's position. This field supports HR workforce categorization, reporting to government entities, and adherence to occupational coding standards.
ClassificationCodeShortName	String		The abbreviated name that corresponds to the occupational classification code. This field supports HR dashboards, summary reports, and compact displays in workforce analytics tools.
ItemID	String		The Id that represents the occupational classification record for the worker's assignment. This field supports auditing, data synchronization, and version control across HR systems and reporting platforms.
NameCode	String		The code that identifies the specific naming convention or group associated with the occupational classification (for example, Engineering, Administrative, or Technical). This field supports HR data organization and workforce segmentation.
NameCodeShortName	String		The abbreviated name that corresponds to the code identifying the occupational classification's group or label. This field supports HR user interfaces, summarized reports, and efficient data retrieval.
AsOfDate	Date		The date that defines when the occupational classification record became effective. This field supports HR auditing, historical reporting, and synchronization with compliance-driven systems.

WorkersWorkAssignmentsWorkerGroups

The view that returns worker group associations within work assignments. This view identifies teams, projects, or groups that workers are assigned to for management and operational reporting.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

AssociateOID supports the '=' comparison.
WorkerID supports the '=' comparison.
AsOfDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE AssociateOID = 'G3349PZGBADQY8H7'

SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE WorkerID = 'DRH9M9NPW'

SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE AsOfDate = '2020-01-01'

Columns


Name	Type	References	Description
AssociateOID	String	Workers.AssociateOID	The unique identifier (Id) that represents the associate linked to the worker group record. This field supports Human Resources (HR) recordkeeping, data synchronization, and workforce assignment tracking.
WorkerID	String	Workers.WorkerID	The Id that identifies the worker whose assignment is associated with a specific worker group. This field supports HR data integration, workforce categorization, and reporting alignment across systems.
GroupCode	String		The code that identifies the worker group to which the assignment belongs. This field supports HR grouping logic, payroll integration, and organization-based analytics.
GroupCodeLongName	String		The full descriptive name that corresponds to the worker group code. This field supports HR documentation, compliance reports, and workforce segmentation analysis.
GroupCodeShortName	String		The abbreviated name that corresponds to the worker group code. This field supports HR dashboards, summary reporting, and system interfaces that require compact field names.
ItemID	String		The Id that represents the individual worker group record associated with a work assignment. This field supports data tracking, version control, and auditability across HR and payroll systems.
NameCode	String		The code that defines the naming convention or type of group that is associated with the worker assignment (for example, Union, Departmental, or Project). This field supports HR organization mapping and workforce classification.
NameCodeLongName	String		The full descriptive name that corresponds to the code defining the type of worker group. This field supports HR reporting, workforce analysis, and compliance documentation.
NameCodeShortName	String		The abbreviated name that corresponds to the code defining the worker group. This field supports HR summaries, user interfaces, and integration with external workforce systems.
AsOfDate	Date		The date that defines when the worker group record became effective. This field supports HR historical tracking, auditing, and synchronization across workforce management systems.

WorkerTypeCode

The view that provides standardized worker type codes. This view classifies workers according to employment type (for example, full-time, part-time, or contractor) to ensure consistent payroll and Human Resources (HR) reporting.

Columns


Name	Type	References	Description
CodeValue	String		The code that represents the type of worker defined within the HR system. This value determines the employment classification that is applied to a worker (for example, employee, contractor, or temporary) and supports reporting, payroll processing, and compliance tracking.
ShortName	String		The abbreviated name that corresponds to the type code for the worker. This field provides a compact reference for HR systems, reports, and dashboards where display space is limited.

WorkSchedules

The view that returns worker schedule data. This view defines standard working hours, shift patterns, and time-off rules that are used in scheduling and payroll processing.

Columns


Name	Type	References	Description
AssociateOID	String		The unique identifier (Id) that represents the associate whose work schedule record is stored in the Human Resources (HR) system. This field supports employee tracking, payroll synchronization, and workforce planning.
ScheduleID	String		The Id that identifies the specific work schedule record assigned to an associate. This field supports HR time management, compliance reporting, and schedule version control.
WorkerName	String		The given name of the worker associated with the schedule record. This field supports identification in HR systems, timekeeping applications, and workforce reports.
WorkerFamilyName1	String		The primary family name of the worker associated with the schedule record. This field supports HR personnel records, scheduling reports, and compliance documentation.
WorkerFormattedName	String		The full formatted name of the worker as displayed in the HR system. This field provides a complete, standardized representation for schedules, reports, and communication materials.
workAssignmentID	String		The Id that identifies the specific work assignment to which this schedule applies. This field supports HR job mapping, shift planning, and data linkage between assignments and schedules.
schedulePeriodStartDate	Date		The date that marks the beginning of the work schedule period. This field supports HR time tracking, payroll processing, and schedule forecasting.
schedulePeriodEndDate	Date		The date that marks the end of the work schedule period. This field supports HR time reconciliation, audit processes, and scheduling accuracy.
scheduleDays	String		The list of days covered by the work schedule (for example, Monday, Tuesday, Wednesday, and so on). This field supports HR planning, workforce allocation, and compliance with scheduling policies.

WorkSchedulesEntries

The view that returns daily or weekly schedule entries that are defined within work schedules. This view includes shift dates, durations, and assignment details to support time tracking and compliance monitoring.

Columns


Name	Type	References	Description
AssociateOID	String		The unique identifier (Id) that represents the associate linked to the work schedule entry. This field supports Human Resources (HR) time management, attendance tracking, and payroll synchronization.
ScheduleID	String		The Id that identifies the overall schedule to which this entry belongs. This field supports HR scheduling processes, shift management, and reporting alignment.
WorkerFormattedName	String		The full formatted name of the worker that is associated with the schedule entry. This field supports identification across HR systems, timekeeping applications, and workforce reports.
workAssignmentID	String		The Id that represents the specific work assignment connected to this schedule entry. This field supports HR job mapping, compliance reporting, and data linkage between assignments and schedules.
ScheduleEntryID	String		The Id that uniquely identifies the schedule-entry record within the schedule. This field supports HR audit tracking, version control, and accurate time allocation.
DaySequenceNumber	String		The number that represents the sequential order of the day within the schedule period. This field supports HR forecasting, reporting, and automation in shift sequencing.
ScheduleDayDate	Date		The calendar date associated with the scheduled workday. This field supports HR attendance tracking, payroll processing, and compliance verification.
Actions	String		The list of actions that are associated with the schedule entry (for example, Created, Modified, Approved). This field supports HR workflow tracking and auditing.
categoryTypeCode	String		The code that represents the category type assigned to the schedule entry. This field supports HR classification, reporting, and policy enforcement for scheduling.
ShiftTypeCode	String		The code that identifies the type of shift scheduled for the worker (for example, Regular, Overtime, or Night). This field supports HR time management, labor cost reporting, and compliance with scheduling rules.
EarningAllocations	String		The earnings that are allocated to the schedule entry based on worked or scheduled time. This field supports payroll integration and HR compensation reporting.
EntryComments	String		The comments that are associated with the schedule entry. This field supports HR communication, audit documentation, and supervisor notes related to scheduling changes.
PayCodeValue	String		The code that represents the pay category assigned to the schedule entry. This field supports HR payroll mapping, accounting integration, and earnings classification.
PayCodeShortName	String		The abbreviated name that corresponds to the pay code value. This field supports HR reporting, payroll summaries, and compact data displays.
EntryStatusCode	String		The code that represents the current processing status of the schedule entry (for example, Active, Pending, or Completed). This field supports HR validation, auditing, and data synchronization.
StateDateTimePeriod	Datetime		The date and time that indicate when the scheduled work period begins. This field supports HR shift tracking, time calculation, and payroll accuracy.
EndDateTimePeriod	Datetime		The date and time that indicate when the scheduled work period ends. This field supports HR shift management, time reporting, and compliance with working hour policies.
StartDatePeriod	Date		The date that marks the beginning of the work schedule period associated with this entry. This field supports HR scheduling, payroll processing, and time validation.
EndDatePeriod	Date		The date that marks the end of the work schedule period associated with this entry. This field supports HR reporting, forecasting, and payroll integration.
TotalTimeValue	String		The total time value that represents the duration of the scheduled period. This field supports HR payroll calculations, overtime validation, and scheduling accuracy.
TotalTimeNameCode	String		The code that identifies the naming convention used for the total time category. This field supports HR reporting and consistency in schedule duration calculations.
TotalTimeNameCodeShortName	String		The abbreviated name that corresponds to the total time name code. This field supports HR summaries, reporting layouts, and integration with time tracking systems.
ScheduledHoursQuantity	String		The total number of hours that are scheduled for the worker during this entry. This field supports HR time allocation, capacity planning, and payroll validation.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with ADP.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from ADP, along with an indication of whether the procedure succeeded or failed.

CData Python Connector for ADP Stored Procedures


Name	Description
DeleteEventMessage	The stored procedure that deletes an event notification record from ADP. This stored procedure is used to manage or clear previously processed event messages from the event queue to maintain data integrity.
GetEventMessage	The stored procedure that retrieves an event notification record from ADP. This stored procedure is used to access pending or historical event messages for synchronization, monitoring, or audit purposes.
GetOAuthAccessToken	Gets an authentication token from ADP.
RefreshOAuthAccessToken	Refreshes the OAuth access token used for authentication with ADP.

DeleteEventMessage

The stored procedure that deletes an event notification record from ADP. This stored procedure is used to manage or clear previously processed event messages from the event queue to maintain data integrity.

Input


Name	Type	Required	Description
MsgId	String	True	The unique identifier (Id) that represents the event notification message to be deleted. This Id is used by ADP to locate and remove the specific event message from the event queue.

GetEventMessage

The stored procedure that retrieves an event notification record from ADP. This stored procedure is used to access pending or historical event messages for synchronization, monitoring, or audit purposes.

Input


Name	Type	Required	Description
DeleteEventMessage	String	False	Specifies whether the event notification record is to be deleted after retrieval. A value of 'true' deletes the event message from ADP once it has been processed, while a value of 'false' retains it for review.

Result Set Columns


Name	Type	Description
EffectiveDateTime	String	The effective date and time that indicate when the event message takes effect in ADP. This value is used to determine the applicability window of the event data.
CreationDateTime	String	The date and time that indicate when the event message was created in ADP. This output helps track the origination and processing order of event notifications.
EventID	String	The unique identifier (Id) that represents the event notification message. This Id is used to reference, audit, or correlate the event record with other system logs.
EventNameCodeValue	String	The code that identifies the event name type (for example, Worker.Hire or Worker.Termination). This code allows systems to categorize event messages by function.
Originator	String	The originator that identifies the system or process that generated the event message. This output supports auditing and traceability of event sources.
Data	String	The event payload data that contains the detailed information transmitted with the event message. This data is used for synchronization, integration, or downstream processing.
MsgId	String	The message identifier (adp-msg-msgid) returned in the response header. This value uniquely identifies the event notification message and is required as the EventId input parameter when calling the DeleteEventMessage stored procedure.

GetOAuthAccessToken

Gets an authentication token from ADP.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The access token used for communication with ADP.
ExpiresIn	String	The remaining lifetime on the access token.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with ADP.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The access token used for communication with ADP.
ExpiresIn	String	The remaining lifetime on the access token.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for ADP:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.
IsInsertable	Boolean	Whether the table can be inserted into.
IsDeleteable	Boolean	Whether rows can be deleted from the table.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Workers table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName = 'Workers'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.
ColumnCapabilities	Int32	A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native ADP procedure.

Pseudo-Columns


Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Workers table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Workers'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
UseUAT	Specifies whether the provider connects to the ADP User Acceptance Testing (UAT) environment instead of production.
MaskSensitiveData	Specifies whether the provider masks sensitive data values in query results.

OAuth

Property	Description
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocation	Specifies the location of the settings file where OAuth values are saved.
OAuthRefreshToken	Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthExpiresIn	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestamp	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

SSL

Property	Description
SSLClientCert	Specifies the TLS (SSL) client certificate issued by ADP that your application presents for authentication.
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
Logfile	Specifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSize	Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.
MaxLogFileCount	Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Caching

Property	Description
AutoCache	Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheProvider	The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.
CacheDriver	The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.
CacheConnection	Specifies the connection string for the specified cache database.
CacheLocation	Specifies the path to the cache when caching to a file.
CacheTolerance	Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.
Offline	Gets the data from the specified cache database instead of live ADP data.
CacheMetadata	Determines whether the provider caches table metadata to a file-based cache database.

Miscellaneous

Property	Description
RowScanDepth	Specifies the number of rows the provider scans to determine data types for custom field columns.
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the maximum number of concurrent threads the provider uses when executing API requests.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PageSize	Specifies the maximum number of records that the provider retrieves per page from ADP.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Readonly	Toggles read-only access to ADP from the provider.
RTK	Specifies 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.
TestConnectionEndpoint	Specifies the API endpoint that the provider uses to test the connection to ADP.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UsePayrollEndpoint	Specifies whether the provider uses the Payroll API to retrieve data for payroll-related views.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Authentication

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

Property	Description
UseUAT	Specifies whether the provider connects to the ADP User Acceptance Testing (UAT) environment instead of production.
MaskSensitiveData	Specifies whether the provider masks sensitive data values in query results.

UseUAT

Specifies whether the provider connects to the ADP User Acceptance Testing (UAT) environment instead of production.

Data Type

bool

Default Value

false

Remarks

By default, the connector connects to the ADP production environment.

When this property is set to false, the connector connects to the production environment.

When this property is set to true, the connector connects to the UAT environment, which is typically used for testing and development accounts.

This property is useful for testing authentication and data access against non-production ADP environments before deploying changes to production.

MaskSensitiveData

Specifies whether the provider masks sensitive data values in query results.

Data Type

bool

Default Value

true

Remarks

This property controls whether sensitive fields, such as credentials or personally identifiable information (PII), are masked in the returned result set.

When this property is set to true, sensitive data is masked to prevent exposure in query results or logs.

When this property is set to false, sensitive data is returned in plain text.

This property is useful when working with environments that require data privacy or compliance with security standards.

OAuth

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

Property	Description
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocation	Specifies the location of the settings file where OAuth values are saved.
OAuthRefreshToken	Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthExpiresIn	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestamp	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

"OFF"

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for:

Logging in users.
Exchanging user credentials for an OAuth access token to be used for authentication.
Providing limited access to applications.

The options for initiating and maintaining OAuth access are named for the parts of that flow that the connector handles:


OFF	The connector provides no automatic OAuth flow initiation. The OAuth flow is handled entirely by the user. This means that the user must refresh the token manually, and reconnect with an updated OAuthAccessToken property when the current token expires.
GETANDREFRESH	The connector handles the entire OAuth flow (both GET and REFRESH). This means that if a token already exists, the connector refreshes it when necessary; if no token currently exists, the connector obtains it by prompting the user to login.
REFRESH	The user obtains the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate.) After the user logs in, the connector handles the refresh of the OAuth Access Token.

For more information on how to set up OAuth and use this property when configuring a connection, see Establishing a Connection.

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the connector and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. The timeout is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.

Note: Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthSettingsLocation

Specifies the location of the settings file where OAuth values are saved.

Data Type

string

Default Value

"%APPDATA%\\CData\\ADP Data Provider\\OAuthSettings.txt"

Remarks

Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.

You can store OAuth values in a central file for shared access to those values, in either of the following ways:

Set InitiateOAuth to either GETANDREFRESH or REFRESH and specify a filepath to the OAuth settings file.
Use memory storage to load the credentials into static memory.

The following sections provide more detail on each of these methods.

Specifying the OAuthSettingsLocation Filepath

The default OAuth setting location is %APPDATA%\\CData\\ADP Data Provider\\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory. Default values vary, depending on the user's operating system.

Windows (ODBC and Power BI): registry://%DSN%
Windows: %APPDATA%CDataADP Data Provider\OAuthSettings.txt
Mac: %APPDATA%/CData/ADP Data Provider/OAuthSettings.txt
Linux: %APPDATA%/CData/ADP Data Provider/OAuthSettings.txt

Loading Credentials Via Memory Storage

Memory locations are specified by using a value starting with memory://, followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose, but it should be unique to the user.

Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again.

To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

Supported Storage Types

memory://: Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)
registry://: Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name like registry://CData Python Connector for ADP Data Source, or registry://%DSN%.
%DSN%: The name of the DSN you are connecting with.
Default (no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with %APPDATA% or %PROGRAMFILES%.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthRefreshToken

Specifies the OAuth refresh token used to request a new access token after the original has expired.

Data Type

string

Default Value

""

Remarks

The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.

The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessTokenproc; stored procedure if you prefer to manage the refresh manually.

When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.

Note: The OAuthRefreshToken should be handled securely and stored in a trusted location. Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthExpiresIn

Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.

To determine how long the user has before the Access Token will expire, check OAuthTokenTimestamp.

OAuthTokenTimestamp

Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

Data Type

string

Default Value

""

Remarks

The OAuth access token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

SSL

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

Property	Description
SSLClientCert	Specifies the TLS (SSL) client certificate issued by ADP that your application presents for authentication.
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLClientCert

Specifies the TLS (SSL) client certificate issued by ADP that your application presents for authentication.

Data Type

string

Default Value

""

Remarks

This property provides the client certificate required for authentication between your application and ADP.

ADP issues the certificate in two parts: a private key and a public certificate. You must combine these into a valid file format and supply them to the connector.

Accepted formats depend on the value of the SSLClientCertType property. If the certificate is encrypted, the password must be specified in SSLClientCertPassword.

For details about obtaining, formatting, and combining your certificate, see Before You Connect.

This property is useful when connecting to ADP environments that require mutual TLS authentication using client certificates.

SSLClientCertType

The type of key store containing the TLS/SSL client certificate.

Possible Values

PFXFILE, PFXBLOB, PEMKEY_FILE, PEMKEY_BLOB

Data Type

string

Default Value

"PFXFILE"

Remarks

This property can take one of the following values:


PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.

SSLClientCertPassword

Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.

Data Type

string

Default Value

""

Remarks

This property provides the password required to open a password-protected certificate store. For ADP connections, this is typically needed if you export your certificate as a .pfx file and assign it a password during creation. If your certificate is in PEM format, this property is usually not required. Ensure that the password matches the one set when exporting the certificate. For more on certificate setup, see Before You Connect.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	`ecadbdda5a1529c58a1e9e09828d70e4`
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Firewall

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

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Possible Values

NONE, TUNNEL, SOCKS4, SOCKS5

Data Type

string

Default Value

"NONE"

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the connector connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the connector opens a connection to ADP. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the connector opens a connection to ADP. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the connector sends data to ADP. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Data Type

string

Default Value

""

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Data Type

int

Default Value

0

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Data Type

string

Default Value

""

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Data Type

string

Default Value

""

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

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

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Data Type

bool

Default Value

true

Remarks

When this connection property is set to True, the connector checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the connector to connect to a specific proxy server, set ProxyAutoDetect to False.

On Windows, the connector reads the proxy settings from the Internet Options in the registry, specifically the registry key HKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Internet Settings\. On Windows 10 and later, this corresponds to the Proxy Settings found in the Windows Settings.

Note that these settings apply only to the current user of the machine. If you're running an application as a service, the connector does not read your own user's settings. You must instead manually supply the proxy settings in the connector's connection properties.

On Mac, the connector reads proxy settings from the system-configured CFNetwork settings.

On Linux, this property is unsupported, and is set to False by default.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Data Type

string

Default Value

""

Remarks

The connector only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the connector instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Data Type

int

Default Value

80

Remarks

The connector only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the connector instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Possible Values

BASIC, DIGEST, NONE, NEGOTIATE, NTLM

Data Type

string

Default Value

"BASIC"

Remarks

Note: The connector only uses this ProxyAuthScheme when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the authentication method specified in your system proxy settings.

Supported authentication types :

BASIC: The connector performs HTTP basic authentication.
DIGEST: The connector performs HTTP digest authentication.
NTLM: The connector retrieves an NTLM token.
NEGOTIATE: The connector retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The username of a user registered with the proxy server.
DIGEST	The username of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

Note: The connector only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the username specified in your system proxy settings.

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The connector only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the password specified in your system proxy settings.

ProxySSLType

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Possible Values

AUTO, ALWAYS, NEVER, TUNNEL

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the connector uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Data Type

string

Default Value

""

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

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

Property	Description
Logfile	Specifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSize	Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.
MaxLogFileCount	Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Logfile

Specifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.

Data Type

string

Default Value

""

Remarks

This property specifies the location and name of the log file where the connector records its operations, including authentication events, query execution, and connection details. If the specified file does not exist, the connector creates it. Ensure that the user or the service running the connector has write access to the specified path or file. Without sufficient permissions, the log file is not created.

Sensitive information from the connection string, such as passwords and tokens, is automatically masked in the logs. However, sensitive information present in the data itself may not be masked.

If you specify a relative path for Logfile, and if the Location property is set, that directory is used as the base path for the log file.

Additional properties allow you to customize logging behavior:

Use Verbosity to control the level of detail of the log file.
Manage log file size with MaxLogFileSize and control the number of retained log files with MaxLogFileCount.
Filter specific log modules by adjusting the LogModules property.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the connector includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Data Type

string

Default Value

""

Remarks

The connector writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual connector operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the connector to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:


Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

MaxLogFileSize

Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.

Data Type

string

Default Value

"100MB"

Remarks

For values lower than 100 KB, the connector uses 100 KB as the minimum allowable size.

To control the total number of log files retained, use the MaxLogFileCount property in conjunction with this property. Together, these properties allow you to manage the size and retention of log files effectively.

MaxLogFileCount

Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Data Type

int

Default Value

-1

Remarks

Each log file name includes the date and time for easier identification.

This property accepts the following values:

A value of 2 or higher sets the maximum number of log files retained.
A value of 1 retains only one log file. When it reaches the maximum size, the file is deleted and replaced by a new one, leaving no history beyond the current log.
A value of 0 or negative indicates no limit on the number of log files, and logging continues indefinitely.

To manage log file size, use the MaxLogFileSize property. The two properties work together to control the size and retention of log files in the logging folder.

Schema

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

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

"%APPDATA%\\CData\\ADP Data Provider\\Schema"

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\ADP Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Caching

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

Property	Description
AutoCache	Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheProvider	The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.
CacheDriver	The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.
CacheConnection	Specifies the connection string for the specified cache database.
CacheLocation	Specifies the path to the cache when caching to a file.
CacheTolerance	Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.
Offline	Gets the data from the specified cache database instead of live ADP data.
CacheMetadata	Determines whether the provider caches table metadata to a file-based cache database.

AutoCache

Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, the connector automatically caches the contents of tables targeted by SELECT queries. The content of these tables is cached to the cache database specified by the CacheConnection and CacheProvider connection properties.

CacheProvider

The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.

Data Type

string

Default Value

""

Remarks

You can cache to ADO.NET providers saved in your ADO.NET global assembly cache (GAC).

CData ADO.NET providers automatically register themselves with the GAC during installation, so you don't need to do so manually.

Third-party ADO.NET providers may or may not automatically register themselves with the GAC during installation. If you want to cache to a third-party ADO.NET provider, consult the documentation for that provider to determine what steps (if any) you must take to register them with the GAC. Once they have been registered, you can supply their namespace in this connection property.

You must also set the CacheConnection connection property to provide a connection string for the specified ADO.NET provider.

The following sections show connection examples and address other requirements for several popular database providers. Refer to CacheConnection for more information on typical connection properties.

SQLite

You can use the Microsoft ADO.NET Provider for SQLite to cache to SQLite databases.

CacheProvider=Microsoft.Data.Sqlite;CacheConnection='DataSource=C:\\Users\\Public\\cache.db;'InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

MySQL

To cache to MySQL, you can use the CData ADO.NET Provider for MySQL:

Cache Provider=System.Data.CData.MySQL;Cache Connection='Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=myUser;Password=myPassword;Security Token=myToken;

SQL Server

You can use the Microsoft .NET Framework Provider for SQL Server, included in the .NET Framework, to cache to SQL Server:

Cache Provider=System.Data.SqlClient;Cache Connection="Server=MyMACHINE\MyInstance;Database=SQLCACHE;User Id=root;Password=admin";InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

Oracle

To cache to Oracle, you can use the Oracle Data Provider for .NET, as shown in the following example:

Cache Provider=Oracle.DataAccess.Client;Cache Connection='User Id=scott;Password=tiger;Data Source=ORCL';InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

The Oracle Data Provider for .NET also requires the Oracle Database Client. When you download the Oracle Database Client, ensure that its bitness matches the bitness of your machine. When you install, select either the Runtime or Administrator installation type. The Instant Client is not sufficient.

PostgreSQL

To cache to PostgreSQL, you can use the CData ADO.NET Provider for PostgreSQL:

Cache Provider=System.Data.CData.PostgreSQL;Cache Connection='Server=localhost;Port=5432;Database=cache;User=postgres;Password=123456';User=myUser;Password=myPassword;Security Token=myToken;

CacheDriver

The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

Note: You must add the JAR file of the specified JDBC driver to the classpath. For CData JDBC drivers, you can find this JAR file in the "lib" subfolder of that driver's installation directory.

You must also set the CacheConnection connection property to provide a connection string for the specified JDBC driver.

For Linux systems and macOS, you need to create a config.ini file on the installation path of the driver (site-packages/cdata). The config.ini file has the following format (the driver and the path of the JDBC driver):

[salesforce.cpython-38-x86_64-linux-gnu.so]
CLASSPATH = /home/usrname/Downloads/lib/cdata.jdbc.postgresql.jar

Examples

The following examples show how to cache to several major databases. For more information on the JDBC URL syntax and typical connection properties, see CacheConnection.

Derby and Java DB

Java DB is the Oracle distribution of Derby. You must add the Derby JDBC driver's JAR file, derbytools.jar, to your classpath to cache to Java DB.

The Derby JDBC driver's JAR file is bundled in db-derby-10.17.1.0-bin.zip, which you can download from this page. You can find derbytools.jar in the "lib" subfolder of this zip file.

After adding derbytools.jar to the classpath, you can cache to a Java DB database as follows:

jdbc:adp:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

To cache to an in-memory database, use a JDBC URL like the following:

jdbc:adp:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:adp:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

MySQL

The following is a JDBC URL for the CData JDBC Driver for MySQL:

  jdbc:adp:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:adp:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:adp:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .

PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:adp:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\\cert.pfx';SSLClientCertPassword='admin@123'

CacheConnection

Specifies the connection string for the specified cache database.

Data Type

string

Default Value

""

Remarks

The target cache database is determined by a combination of this connection property and the CacheProvider connection property. Both properties are required to use the specified cache database.

The connection string specified in this connection property is passed directly to the specified in the CacheProvider connection property. Consult the documentation for the specified for more information on its available connection properties.

Examples of common cache database settings can be found below.

SQLite

MySQL

The following are typical connection properties:

Server: The IP address or domain name of the server hosting the MySQL database that you want to cache to.
Port: The port on the specified server where your MySQL instance is running.
Database: The name of the MySQL database that you want to cache to. Must match the name of a MySQL database hosted on the specified server.
User: The username of a user registered with the selected MySQL database.
Password: The password associated with the specified MySQL user.

SQL Server

The following are typical SQL Server connection properties:

Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, specify the host name and the instance name, separated by a backslash.
Port: The port on the specified server where your SQL Server instance is running.
Database: The name of the SQL Server database you want to cache to. Must match the name of a SQL Server database hosted on the specified server.
Integrated Security: To use the current Windows account for authentication, set this option to True. To authenticate with User and Password instead, set this option to False.
User Id: The username of a user registered with the selected SQL Server database. This property is only needed if you are not using integrated security.
Password: The password associated with the specified SQL Server user. This property is only needed if you are not using integrated security.

Oracle

The following are typical connection properties:

Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
User Id: The username of a user registered with the selected Oracle database.
Password: The password associated with the specified Oracle user.

PostgreSQL

The following are typical connection properties:

Host: The address of the server hosting the PostgreSQL database.
Port: The port on the specified host server where your PostgreSQL database is hosted.
Database: The name of the PostgreSQL database you want to cache to. Must match the name of a PostgreSQL database hosted on the specified server.
User name: The username of a user registered with the selected PostgreSQL database.
Password: The password associated with the specified user.

CacheLocation

Specifies the path to the cache when caching to a file.

Data Type

string

Default Value

"%APPDATA%\\CData\\ADP Data Provider"

Remarks

The CacheLocation is a simple, file-based cache.

If left unspecified, the default location is %APPDATA%\\CData\\ADP Data Provider, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

CacheTolerance

Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.

Data Type

int

Default Value

600

Remarks

When you execute a query for tables in the cache, the connector checks the time elapsed since the last update to the cache.

If the last update to the cache is older than the value of this connection property (measured in seconds), the connector refreshes the cache.

Otherwise, the connector returns data directly from the cache.

Offline

Gets the data from the specified cache database instead of live ADP data.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, all queries execute against the cache database instead of the live ADP data.

In this mode, some SQL operations like INSERT, UPDATE, DELETE, and CACHE are disabled.

CacheMetadata

Determines whether the provider caches table metadata to a file-based cache database.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, as you execute queries, table metadata in the ADP catalog is cached to the cache database specified by CacheConnection and CacheProvider, or, if those connection properties are not set, to the user's home directory.

The location of your home directory varies by platform:


Platform	Home Directory
Windows	%APPDATA%\\CData\\ADP Data Provider
Mac	~/Library/Application Support/CData/ADP Data Provider
Unix	~/.config/CData/ADP Data Provider

A table's metadata is retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

When there are a large number of ADP tables and columns for the connector to retrieve during metadata discovery, the connector may take a while to list all table metadata.

You may experience slow metadata retrieval when:

Your ADP instance naturally has a large table count.
The connector has been configured, via its connection properties, to discover more tables than it would under its default configuration.
You make many short-lived connections to the connector.

With CacheMetadata enabled, all retrieved metadata is mirrored in the cache database. This means that any subsequent attempts by the connector to discover metadata are much faster, as this metadata is then read directly from the cache database, without needing to spend time requesting metadata from ADP.

When Not to Use CacheMetadata

The connector automatically persists metadata in memory for up to an hour when you first discover the metadata for a table or view, so CacheMetadata is generally not necessary.

CacheMetadata is not ideal in scenarios where you are working with volatile metadata. The first time you query a table, the connector caches its metadata to the cache database file. This cache is not dynamically updated to reflect updates to the table schema, so you must delete and rebuild the cache database file to pick up new, changed, or deleted columns.

Miscellaneous

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

Property	Description
RowScanDepth	Specifies the number of rows the provider scans to determine data types for custom field columns.
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the maximum number of concurrent threads the provider uses when executing API requests.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PageSize	Specifies the maximum number of records that the provider retrieves per page from ADP.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Readonly	Toggles read-only access to ADP from the provider.
RTK	Specifies 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.
TestConnectionEndpoint	Specifies the API endpoint that the provider uses to test the connection to ADP.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UsePayrollEndpoint	Specifies whether the provider uses the Payroll API to retrieve data for payroll-related views.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

RowScanDepth

Specifies the number of rows the provider scans to determine data types for custom field columns.

Data Type

string

Default Value

"100"

Remarks

This property controls how many rows the connector examines when detecting data types for columns created by custom fields.

Increasing the value can improve accuracy in determining data types but may decrease performance, especially for large tables. Decreasing the value can improve performance, but may cause some data types to be inferred incorrectly.

This property is useful when working with tables that contain many custom fields or when data type detection requires higher accuracy.

IncludeCustomFields

A boolean indicating if you would like to include custom fields in the column listing.

Data Type

bool

Default Value

true

Remarks

Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

MaxThreads

Specifies the maximum number of concurrent threads the provider uses when executing API requests.

Data Type

string

Default Value

"5"

Remarks

This property allows you to issue multiple requests simultaneously, thereby improving performance.

This property controls the number of simultaneous API requests the connector can send to ADP.

Increasing the number of threads can improve performance when retrieving large data sets, but may also increase load on the ADP API or your network.

This property is useful when tuning performance for high-volume data operations or optimizing throughput across multiple concurrent queries.

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Caching Configuration


Property	Description
CachePartial=True	Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True	Passes the specified query to the cache database instead of using the SQL parser of the connector.

Integration and Formatting


Property	Description
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PageSize

Specifies the maximum number of records that the provider retrieves per page from ADP.

Data Type

int

Default Value

100

Remarks

This property determines how many records the connector requests per page when executing a query.

Increasing the page size reduces the number of round trips required to retrieve large data sets, but can also increase response time or cause timeouts for large requests.

The maximum supported page size is 100.

This property is useful for optimizing performance and balancing query efficiency against API response time.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Readonly

Toggles read-only access to ADP from the provider.

Data Type

bool

Default Value

false

Remarks

When set to True, the connector allows only SELECT queries. Attempting an INSERT, UPDATE, DELETE, or stored procedure query fails with an error message.

RTK

Specifies 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.

Data Type

string

Default Value

""

Remarks

This property is typically unnecessary, as most configurations support a standard licensing mechanism.

Warning: The value of this property takes precedence over all existing licensing information. To avoid licensing errors, ensure the provided runtime key is correct.

TestConnectionEndpoint

Specifies the API endpoint that the provider uses to test the connection to ADP.

Possible Values

workers, worker-demographics

Data Type

string

Default Value

"workers"

Remarks

This property defines which ADP REST API resource the connector queries to confirm that authentication was successful and that the connection is active.

During connection testing, the connector performs a simple GET request to the specified endpoint to verify that valid credentials and API access are in place.

The default endpoint is workers, which is accessible in most ADP environments. If your account does not have permission to access this endpoint, set the property to an alternate resource such as worker-demographics.

This property is useful for troubleshooting authentication issues or validating connectivity when working in limited-access or custom ADP API environments.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UsePayrollEndpoint

Specifies whether the provider uses the Payroll API to retrieve data for payroll-related views.

Data Type

bool

Default Value

false

Remarks

When enabled, the connector retrieves data for the following payroll views using ADP’s Payroll API instead of the default API:

AssociatePaymentsAllocationsEarningSections
AssociatePaymentsAllocationsStatutoryDeductions
AssociatePaymentsAllocationsNonStatutoryDeductions
AssociatePaymentsSummaryEarningsSections
AssociatePaymentsSummaryStatutoryDeductions
AssociatePaymentsSummaryPayrollAccumulations

When this property is set to true, payroll data is returned through the Payroll API, which may increase data retrieval time or impact performance.

This property is useful when you need to query payroll-related data that is only available through the Payroll API.

UserDefinedViews

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Workers WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the connector only sees that view.

For further information, see User Defined Views.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

AdoptOpenJDK / Adoptium Temurin JRE 17.0.18_8

Apache License, Version 2.0

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Eclipse Distribution License - v 1.0

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Eclipse Foundation, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Eclipse Public License - v 2.0

THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS "Contribution" means:

a) in the case of the initial Contributor, the initial content Distributed under this Agreement, and
b) in the case of each subsequent Contributor:
- i) changes to the Program, and
- ii) additions to the Program;
where such changes and/or additions to the Program originate from and are Distributed by that particular Contributor. A Contribution "originates" from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include changes or additions to the Program that are not Modified Works.

"Contributor" means any person or entity that Distributes the Program. "Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions Distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement or any Secondary License (as applicable), including Contributors.

"Derivative Works" shall mean any work, whether in Source Code or other form, that is based on (or derived from) the Program and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship.

"Modified Works" shall mean any work in Source Code or other form that results from an addition to, deletion from, or modification of the contents of the Program, including, for purposes of clarity any new file in Source Code form that contains any contents of the Program. Modified Works shall not include works that contain only declarations, interfaces, types, classes, structures, or files of the Program solely in each case in order to link to, bind by name, or subclass the Program or Modified Works thereof.

"Distribute" means the acts of a) distributing or b) making available in any manner that enables the transfer of a copy.

"Source Code" means the form of a Program preferred for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Secondary License" means either the GNU General Public License, Version 2.0, or any later versions of that license, including any exceptions or additional permissions as identified by the initial Contributor.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, Distribute and sublicense the Contribution of such Contributor, if any, and such Derivative Works.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in Source Code or other form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to Distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
e) Notwithstanding the terms of any Secondary License, no Contributor makes additional grants to any Recipient (other than those set forth in this Agreement) as a result of such Recipient's receipt of the Program under the terms of a Secondary License (if permitted under the terms of Section 3).

3. REQUIREMENTS 3.1 If a Contributor Distributes the Program in any form, then:

a) the Program must also be made available as Source Code, in accordance with section 3.2, and the Contributor must accompany the Program with a statement that the Source Code for the Program is available under this Agreement, and informs Recipients how to obtain it in a reasonable manner on or through a medium customarily used for software exchange; and
b) the Contributor may Distribute the Program under a license different than this Agreement, provided that such license:
- i) effectively disclaims on behalf of all other Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
- ii) effectively excludes on behalf of all other Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
- iii) does not attempt to limit or alter the recipients' rights in the Source Code under section 3.2; and
- iv) requires any subsequent distribution of the Program by any party to be under a license that satisfies the requirements of this section 3.

3.2 When the Program is Distributed as Source Code:

a) it must be made available under this Agreement, or if the Program (i) is combined with other material in a separate file or files made available under a Secondary License, and (ii) the initial Contributor attached to the Source Code the notice described in Exhibit A of this Agreement, then the Program may be made available under the terms of such Secondary Licenses, and
b) a copy of this Agreement must be included with each copy of the Program.

3.3 Contributors may not remove or alter any copyright, patent, trademark, attribution notices, disclaimers of warranty, or limitations of liability (‘notices') contained within the Program from any copy of the Program which they Distribute, provided that Contributors may add their own appropriate notices.

4. COMMERCIAL DISTRIBUTION Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be Distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to Distribute the Program (including its Contributions) under the new version.

Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved. Nothing in this Agreement is intended to be enforceable by any entity that is not a Contributor or Recipient. No third-party beneficiary rights are created under this Agreement.

Exhibit A – Form of Secondary Licenses Notice "This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), version(s), and exceptions or additional permissions here}."

Simply including a copy of this Agreement, including this Exhibit A is not sufficient to license the Source Code under Secondary Licenses.

If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.

You may add additional accurate notices of copyright ownership.

GNU Classpath

Classpath is distributed under the terms of the GNU General Public License with the following clarification and special exception.

Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination.

As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

As such, it can be used to run, create and distribute a large class of applications and applets. When GNU Classpath is used unmodified as the core class library for a virtual machine, compiler for the java languge, or for a program written in the java programming language it does not affect the licensing for distributing those programs directly.

OpenJDK Assembly Exception

The OpenJDK source code made available by Oracle America, Inc. (Oracle) at openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU General Public License <http://www.gnu.org/copyleft/gpl.html> version 2 only ("GPL2"), with the following clarification and special exception.

Linking this OpenJDK Code statically or dynamically with other code is making a combined work based on this library. Thus, the terms and conditions of GPL2 cover the whole combination.

As a special exception, Oracle gives you permission to link this OpenJDK Code with certain code licensed by Oracle as indicated at http://openjdk.java.net/legal/exception-modules-2007-05-08.html ("Designated Exception Modules") to produce an executable, regardless of the license terms of the Designated Exception Modules, and to copy and distribute the resulting executable under GPL2, provided that the Designated Exception Modules continue to be governed by the licenses under which they were offered by Oracle.

As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code to build an executable that includes those portions of necessary code that Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 with the Classpath exception). If you modify or add to the OpenJDK code, that new GPL2 code may still be combined with Designated Exception Modules if the new code is made subject to this exception by its copyright holder.

CData Python Connector for ADP

CData Python Connector for ADP

Overview

Key Features

Getting Started

Using the Python Connector/Using from Tools

SQLAlchemy ORM

Pandas

Schema Discovery

Advanced Features

SQL Compliance

Data Model

Connection String Options

Getting Started

Connecting to ADP

Python Version Support

ADP Version Support

See Also

Before You Connect

Retrieving Your SSL Certificate from the Developer Self-Service Portal

Retrieving Your SSL Certificate with the Manual CSR Process

Retrieving Your SSL Certificate from API Central

Combining the Private Key and Public Certificate

Package Installation

Dependencies

Installation

Upgrading

Licensing

Uninstallation

Establishing a Connection

Connecting to ADP

Configuring JNI

Configure the Config INI File

Configure Environment Variables

Custom Logger

Changelog

General Changes

Using the Connector

Connecting from Code

Executing SQL

Executing Stored Procedures

Batch Processing

Connecting

Connecting with the cdata.adp Module:

Querying Data

Executing Queries

Parameterized Queries

Modifying Data

Insert

Update

Delete

Calling Stored Procedures

Calling Stored Procedures Using Execute()

Calling Stored Procedures Using Callproc()

Batch Processing

Insert

Using from Tools

Python Integration Guides

Complete List of ADP Integration Quickstarts

From SQLAlchemy

Connecting From SQLAlchemy

Reflecting Metadata With SQLAlchemy

Querying Data From SQLAlchemy

Modifying Data From SQLAlchemy

Connecting

Connecting With a Dialect URL

Reflecting Metadata

Modeling Data Using a Mapping Class

Automatically Reflecting Metadata

Querying Data

Querying Data Using the Query Method

Querying Data Using the Execute Method

Executing JOINs

Implicit Joining

Other Join Forms

Other SQL Clauses

ORDER BY

GROUP BY

LIMIT and OFFSET

Aggregate Functions