> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/release8.1/connectors/connector-repositories/application/adp-workforce-now.md).

# ADP Workforce Now

This article outlines the integration with the ADP Workforce Now connector, enabling streamlined metadata management through features such as crawling, sample profiling, data preview, and manual lineage. The connector extracts metadata from ADP Workforce Now and imports schemas, tables, columns, and relationships into OvalEdge for metadata discovery.

This connector connects to ADP Workforce Now using REST APIs with OAuth 2.0 authentication and an SSL (.jks) certificate. It supports Client App Credentials and Instance Credentials authentication methods to establish secure access to ADP Workforce Now.

<img src="/files/YPgnQqtV6uOVgjPJcKqa" alt="" height="331" width="624">

## Overview

### Connector Details

| Connector Category                                                                    | Application                        |
| ------------------------------------------------------------------------------------- | ---------------------------------- |
| OvalEdge Release Supported                                                            | Release6.0 and later               |
| <p>Connectivity</p><p>\[How the connection is established with ADP Workforce Now]</p> | REST APIs (OAuth 2.0 + SSL .jks)   |
| Verified ADP Workforce Now Version                                                    | HR Workers API v2 (/hr/v2/workers) |

{% hint style="info" %}
The ADP Workforce Now connector has been validated with the mentioned "Verified ADP Workforce Now Versions" and is expected to be compatible with other supported ADP Workforce Now versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.
{% endhint %}

### Connector Features

<table data-search="false"><thead><tr><th>Feature</th><th align="center">Availability</th></tr></thead><tbody><tr><td>Crawling</td><td align="center">✅</td></tr><tr><td>Delta Crawling</td><td align="center">❌</td></tr><tr><td>Profiling</td><td align="center">❌</td></tr><tr><td>Sample Profiling</td><td align="center">✅</td></tr><tr><td>Query Sheet</td><td align="center">❌</td></tr><tr><td>Data Preview</td><td align="center">✅</td></tr><tr><td>Auto Lineage</td><td align="center">❌</td></tr><tr><td>Manual Lineage</td><td align="center">✅</td></tr><tr><td>Secure Authentication via Credential Manager</td><td align="center">✅</td></tr><tr><td>Data Quality</td><td align="center">❌</td></tr><tr><td>DAM (Data Access Management)</td><td align="center">❌</td></tr><tr><td>Bridge</td><td align="center">✅</td></tr></tbody></table>

### Metadata Mapping

The following objects are crawled from ADP Workforce Now and mapped to the corresponding UI assets.

<table data-search="false"><thead><tr><th width="163">ADP Workforce Object</th><th width="199">ADP Workforce Attribute</th><th>OvalEdge Attribute</th><th>OvalEdge Category</th><th>OvalEdge Type</th></tr></thead><tbody><tr><td>Schema</td><td>/hr/v2/workers/meta</td><td>Schema</td><td>Schemas</td><td>Schema</td></tr><tr><td>Schema</td><td>Schema comment</td><td>Schema Comments</td><td>Schemas</td><td>Schema</td></tr><tr><td>Table</td><td>Object path name</td><td>Table</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td>Table type</td><td>Table Type</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td>Table comment</td><td>Table Comments</td><td>Tables</td><td>table</td></tr><tr><td>Column</td><td>Field name</td><td>Column</td><td>Columns</td><td>Column</td></tr><tr><td>Column</td><td>JSON type</td><td>Column Data Type</td><td>Columns</td><td>Column</td></tr><tr><td>Column</td><td>Field description</td><td>Column Comments</td><td>Columns</td><td>Column</td></tr><tr><td>Column</td><td>Field label</td><td>Column Title</td><td>Columns</td><td>Column</td></tr><tr><td>Column</td><td>Column order</td><td>Column Position</td><td>Columns</td><td>Column</td></tr><tr><td>Column</td><td>API path</td><td>Additional Information</td><td>Columns</td><td>Column</td></tr><tr><td>Relation</td><td>WORKER_ID parent-child</td><td>Column Relation</td><td>Relations</td><td>Relation</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

**Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a dedicated service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
**👨‍💻 Who can provide these permissions?** These permissions are typically granted by the ADP Workforce Now administrator, as users may not have the required access to assign them independently.
{% endhint %}

<table><thead><tr><th width="158">Operations</th><th width="160">Objects</th><th width="271">Sys Tables</th><th>Access Permissions</th></tr></thead><tbody><tr><td>Connection Validation</td><td>-</td><td>Token API, Subscriber Credential API (Client Credentials) / Token API (Instance Credentials)</td><td>OAuth Client Credentials, SSL Certificate (.jks)</td></tr><tr><td>Crawling</td><td>Schema</td><td>/hr/v2/workers/meta</td><td>Read</td></tr><tr><td>Crawling</td><td>Tables</td><td>Predefined Workers API object paths (ADPTableRef)</td><td>Read</td></tr><tr><td>Crawling / Sample Profiling</td><td>Table Columns</td><td>/hr/v2/workers/meta</td><td>Read</td></tr><tr><td>Crawling</td><td>Relationships</td><td>Synthetic WORKER_ID relationships</td><td>Read</td></tr><tr><td>Sample Profiling / Data Preview</td><td>Tables / Table Columns</td><td>/hr/v2/workers</td><td>Read</td></tr></tbody></table>

{% hint style="info" %}

* The connector creates a logical schema using the Workers Meta endpoint because ADP Workforce Now does not provide a native schema catalog.
* Tables and columns are derived from the Workers API metadata. Sub-Table and JSON columns are excluded from profiling.
* Relationships are generated using the WORKER\_ID field across related worker tables.
* The connector supports OAuth 2.0 Client Credentials and Instance Credentials authentication with an SSL certificate (.jks). Client Credentials authentication additionally requires a Subscriber OOID.
  {% endhint %}

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into **OvalEdge**, go to **Administration** > **Connectors**, click **+ (New Connector)**, search for **ADP Workforce Now**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="219">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "ADP Workforce Now" is displayed as the selected connector type.</td></tr><tr><td>Authentication*</td><td><p>Select the authentication method for the ADP Workforce Now connection. The following two authentication methods are supported:</p><ul><li>Client App Credentials</li><li>Instance Credentials</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="Client App Credentials" %}

<table><thead><tr><th width="201">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul><p>For more details, click<a href="https://docs.ovaledge.com/connectors/additional-requirements/credential-manager-configuration"> here</a>. </p></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the ADP Workforce Now connection              </p><p>(Example: "ADP Workforce Now_Prod").</p></td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Client Id*</td><td>Enter the OAuth Client ID provided for the ADP application. This ID is used to authenticate the application when requesting an access token.</td></tr><tr><td>Client Secret*</td><td>Enter the OAuth Client Secret associated with the Client ID. This secret is used together with the Client ID to obtain an OAuth access token.</td></tr><tr><td>SSL Certificate Path</td><td>Enter the full path to the SSL certificate (.jks) file used for mutual TLS authentication with ADP APIs. Both Windows and Unix file paths are supported.</td></tr><tr><td>Store Password</td><td>Enter the password used to access the SSL certificate (.jks) keystore.</td></tr><tr><td>Key Password</td><td>Enter the password for the private key stored in the SSL certificate (.jks) file, if different from the Store Password.</td></tr><tr><td>Subscriber OOID*</td><td>Enter the Subscriber Organization Object ID (OOID) provided by ADP. This value is required to retrieve subscriber-specific credentials when using Client App Credentials authentication.</td></tr><tr><td>Grant Type</td><td>Displays the OAuth grant type used for authentication. The default value is client_credentials. Modify this value only if required by the ADP environment.</td></tr><tr><td>Proxy Enabled*</td><td>Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.</td></tr><tr><td>Token Server Type</td><td>Enter the OAuth token endpoint used to generate access tokens. By default, the connector uses https://accounts.adp.com/auth/oauth/v2/token. Modify this value only if a different token server endpoint is provided by ADP.</td></tr><tr><td>API Request URL</td><td>Enter the base URL used to access ADP Workforce Now APIs. By default, the connector uses https://api.adp.com. Modify this value only if a different API endpoint is provided by ADP.</td></tr></tbody></table>
{% endtab %}

{% tab title="Instance Credentials" %}

<table><thead><tr><th width="191">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul><p>For more details, click<a href="https://docs.ovaledge.com/connectors/additional-requirements/credential-manager-configuration"> here</a>.</p></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the ADP Workforce Now connection              </p><p>(Example: "ADP Workforce Now_Prod").</p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Client Id*</td><td>Enter the OAuth Client ID provided for the ADP instance. This ID is used to authenticate the application when requesting an access token.</td></tr><tr><td>Client Secret*</td><td>Enter the OAuth Client Secret associated with the Client ID. This secret is used together with the Client ID to obtain an OAuth access token.</td></tr><tr><td>SSL Certificate Path</td><td>Enter the full path to the SSL certificate (.jks) file used for mutual TLS authentication with ADP APIs. Both Windows and Unix file paths are supported.</td></tr><tr><td>Store Password</td><td>Enter the password used to access the SSL certificate (.jks) keystore.</td></tr><tr><td>Key Password</td><td>Enter the password for the private key stored in the SSL certificate (.jks) file, if different from the Store Password.</td></tr><tr><td>Grant Type</td><td>Displays the OAuth grant type used for authentication. The default value is client_credentials. Modify this value only if required by the ADP environment.</td></tr><tr><td>Proxy Enabled*</td><td>Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.</td></tr><tr><td>Token Server Type </td><td>Enter the OAuth token endpoint used to generate access tokens. By default, the connector uses https://accounts.adp.com/auth/oauth/v2/token. Modify this value only if a different token server endpoint is provided by ADP.</td></tr><tr><td>API Request URL</td><td>Enter the base URL used to access ADP Workforce Now APIs. By default, the connector uses https://api.adp.com. Modify this value only if a different API endpoint is provided by ADP.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="221"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="221"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="219"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="221"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="warning" %}
To perform crawl and profile operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for crawling and profiling.&#x20;

1. Navigate to the Connectors page and click **Crawl/Profile**.
2. Select the schemas to crawl.
3. The **Crawl** option is selected by default. Click the **Crawl & Profile** radio button to perform both crawling and profiling operations.
4. Click **Run** to collect metadata from the connected source and load it into the OvalEdge Data Catalog.
5. After a successful crawl, the information appears in the **Data Catalog** > **Databases** tab.

The Schedule checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the **Select** Period drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the selected operation (**Crawl** or **Crawl & Profile**) at the scheduled time.

#### Other Operations

The Connectors page in OvalEdge provides a centralized view of all configured connectors, including their health status.

**Managing connectors includes:**

* **Connectors Health**: Displays the current status of each connector using a **green** icon for active connections and a **red** icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing**: Click the **Eye** icon next to the connector name to view connector details, including schema, tables, and columns.

N**ine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the **Nine Dots** menu.

* **Edit Connector**: Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings:** Modify connector settings.
  * **Crawler:** Configure data extraction.
  * **Profiler**: Customize data profiling rules and methods.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings**: Manage term associations at the connector level.
* **Delete Connector**: Remove a connector with confirmation.

For more details on connector settings, click [here](https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/connector-settings).

## Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="87">S. No.</th><th width="176">Error Message</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Broken Pipeline</td><td><p><strong>Description</strong>: The API request failed because the ADP API rate limit or traffic threshold was exceeded.</p><p><strong>Resolution</strong>:</p><ul><li>Wait for a few minutes before retrying the operation.</li><li>Reduce the frequency of consecutive API requests.</li><li>Retry the operation during periods of lower API activity.</li></ul></td></tr><tr><td>2</td><td>Error while Validating / Error in fetching bearer</td><td><p><strong>Description</strong>: The connector could not obtain an OAuth access token from the ADP token server.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the Grant Type is set to client_credentials.</li><li>Confirm that the Client ID and Client Secret are valid.</li><li>Verify the Token Server URL and SSL certificate (.jks) path, Store Password, and Key Password.</li></ul></td></tr><tr><td>3</td><td>Error while fetching subscriber token</td><td><p><strong>Description</strong>: The connector could not retrieve subscriber credentials when using Client App Credentials authentication.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the Subscriber OOID is correct.</li><li>Ensure the ADP application has access to the consumer-application-subscription-credentials.read endpoint.</li><li>Retry the connection validation after confirming the required permissions.</li></ul></td></tr><tr><td>4</td><td>Error in Importing Certificate</td><td><p><strong>Description</strong>: The SSL certificate could not be loaded or validated during authentication.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the SSL certificate (.jks) file path is correct and accessible.</li><li>Confirm that the Store Password and Key Password are valid.</li><li>Ensure the certificate file is not corrupted and has the appropriate access permissions.</li></ul></td></tr><tr><td>5</td><td>Error while crawling Remote Tables / Columns</td><td><p><strong>Description</strong>: The connector could not retrieve metadata from the Workers Meta API.</p><p><strong>Resolution</strong>:</p><ul><li>Ensure the ADP application has access to the Workers API.</li><li>Verify Read permission for the /hr/v2/workers/meta endpoint.</li><li>Validate the connection after updating the required API permissions.</li></ul></td></tr><tr><td>6</td><td>Error while getting data from ADP table / Sample Profile</td><td><p><strong>Description</strong>: The connector could not retrieve worker data for sample profiling or data preview.</p><p><strong>Resolution</strong>:</p><ul><li>Verify read permission for the /hr/v2/workers endpoint.</li><li>Retry the operation after confirming API access.</li><li>Reduce the sample size if the request is affected by API rate limits.</li></ul></td></tr><tr><td>7</td><td>Proxy / Connection Errors</td><td><p><strong>Description</strong>: The connector could not establish a network connection to the ADP services.</p><p><strong>Resolution</strong>:</p><ul><li>Enable the Proxy option if the environment requires a proxy server.</li><li>Ensure outbound HTTPS access to accounts.adp.com and api.adp.com is allowed.</li><li>Verify firewall and network settings that may block the connection.</li></ul></td></tr></tbody></table>

***

&#x20;Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ovaledge.com/release8.1/connectors/connector-repositories/application/adp-workforce-now.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.