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.
Overview
Connector Details
Connector Category
Application
OvalEdge Release Supported
Release6.0 and later
Connectivity
[How the connection is established with ADP Workforce Now]
REST APIs (OAuth 2.0 + SSL .jks)
Verified ADP Workforce Now Version
HR Workers API v2 (/hr/v2/workers)
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.
Connector Features
Crawling
✅
Delta Crawling
❌
Profiling
❌
Sample Profiling
✅
Query Sheet
❌
Data Preview
✅
Auto Lineage
❌
Manual Lineage
✅
Secure Authentication via Credential Manager
✅
Data Quality
❌
DAM (Data Access Management)
❌
Bridge
✅
Metadata Mapping
The following objects are crawled from ADP Workforce Now and mapped to the corresponding UI assets.
Schema
/hr/v2/workers/meta
Schema
Schemas
Schema
Schema
Schema comment
Schema Comments
Schemas
Schema
Table
Object path name
Table
Tables
table
Table
Table type
Table Type
Tables
table
Table
Table comment
Table Comments
Tables
table
Column
Field name
Column
Columns
Column
Column
JSON type
Column Data Type
Columns
Column
Column
Field description
Column Comments
Columns
Column
Column
Field label
Column Title
Columns
Column
Column
Column order
Column Position
Columns
Column
Column
API path
Additional Information
Columns
Column
Relation
WORKER_ID parent-child
Column Relation
Relations
Relation
Set up a Connection
Prerequisites
The following are the prerequisites to establish a connection:
Service Account User Permissions
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.
👨💻 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.
Connection Validation
-
Token API, Subscriber Credential API (Client Credentials) / Token API (Instance Credentials)
OAuth Client Credentials, SSL Certificate (.jks)
Crawling
Schema
/hr/v2/workers/meta
Read
Crawling
Tables
Predefined Workers API object paths (ADPTableRef)
Read
Crawling / Sample Profiling
Table Columns
/hr/v2/workers/meta
Read
Crawling
Relationships
Synthetic WORKER_ID relationships
Read
Sample Profiling / Data Preview
Tables / Table Columns
/hr/v2/workers
Read
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.
Connection Configuration Steps
Users are required to have the Connector Creator role in order to configure a new connection.
Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for ADP Workforce Now, and complete the required parameters.
Fields marked with an asterisk (*) are mandatory for establishing a connection.
Connector Type
By default, "ADP Workforce Now" is displayed as the selected connector type.
Authentication*
Select the authentication method for the ADP Workforce Now connection. The following two authentication methods are supported:
Client App Credentials
Instance Credentials
Credential Manager*
Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.
Supported Credential Managers:
OE Credential Manager
AWS Secrets Manager
HashiCorp Vault
Azure Key Vault
For more details, click here.
Connector Name*
Enter a unique name for the ADP Workforce Now connection
(Example: "ADP Workforce Now_Prod").
Connector Description
Enter a brief description of the connector.
Client Id*
Enter the OAuth Client ID provided for the ADP application. This ID is used to authenticate the application when requesting an access token.
Client Secret*
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.
SSL Certificate Path
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.
Store Password
Enter the password used to access the SSL certificate (.jks) keystore.
Key Password
Enter the password for the private key stored in the SSL certificate (.jks) file, if different from the Store Password.
Subscriber OOID*
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.
Grant Type
Displays the OAuth grant type used for authentication. The default value is client_credentials. Modify this value only if required by the ADP environment.
Proxy Enabled*
Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.
Token Server Type
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.
API Request URL
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.
Credential Manager*
Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.
Supported Credential Managers:
OE Credential Manager
AWS Secrets Manager
HashiCorp Vault
Azure Key Vault
For more details, click here.
Connector Name*
Enter a unique name for the ADP Workforce Now connection
(Example: "ADP Workforce Now_Prod").
Connector description
Enter a brief description of the connector.
Client Id*
Enter the OAuth Client ID provided for the ADP instance. This ID is used to authenticate the application when requesting an access token.
Client Secret*
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.
SSL Certificate Path
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.
Store Password
Enter the password used to access the SSL certificate (.jks) keystore.
Key Password
Enter the password for the private key stored in the SSL certificate (.jks) file, if different from the Store Password.
Grant Type
Displays the OAuth grant type used for authentication. The default value is client_credentials. Modify this value only if required by the ADP environment.
Proxy Enabled*
Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.
Token Server Type
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.
API Request URL
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.
Default Governance Roles
Default Governance Roles*
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.
Admin Roles
Admin Roles*
Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.
No of Archive Objects
No Of Archive Objects*
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.
Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.
Bridge
Select Bridge*
If applicable, select the bridge from the drop-down list.
The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.
After entering all connection details, the following actions can be performed:
Click Validate to verify the connection.
Click Save to store the connection for future use.
Click Save & Configure to apply additional settings before saving.
The saved connection will appear on the Connectors home page.
Manage Connector Operations
Crawl/Profile
To perform crawl and profile operations, users must be assigned the Integration Admin role.
The Crawl/Profile button allows users to select one or more schemas for crawling and profiling.
Navigate to the Connectors page and click Crawl/Profile.
Select the schemas to crawl.
The Crawl option is selected by default. Click the Crawl & Profile radio button to perform both crawling and profiling operations.
Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.
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.
Click the Schedule checkbox to enable the Select Period drop-down.
Select a time period for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
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.
Nine 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.
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.
1
Broken Pipeline
Description: The API request failed because the ADP API rate limit or traffic threshold was exceeded.
Resolution:
Wait for a few minutes before retrying the operation.
Reduce the frequency of consecutive API requests.
Retry the operation during periods of lower API activity.
2
Error while Validating / Error in fetching bearer
Description: The connector could not obtain an OAuth access token from the ADP token server.
Resolution:
Verify that the Grant Type is set to client_credentials.
Confirm that the Client ID and Client Secret are valid.
Verify the Token Server URL and SSL certificate (.jks) path, Store Password, and Key Password.
3
Error while fetching subscriber token
Description: The connector could not retrieve subscriber credentials when using Client App Credentials authentication.
Resolution:
Verify that the Subscriber OOID is correct.
Ensure the ADP application has access to the consumer-application-subscription-credentials.read endpoint.
Retry the connection validation after confirming the required permissions.
4
Error in Importing Certificate
Description: The SSL certificate could not be loaded or validated during authentication.
Resolution:
Verify that the SSL certificate (.jks) file path is correct and accessible.
Confirm that the Store Password and Key Password are valid.
Ensure the certificate file is not corrupted and has the appropriate access permissions.
5
Error while crawling Remote Tables / Columns
Description: The connector could not retrieve metadata from the Workers Meta API.
Resolution:
Ensure the ADP application has access to the Workers API.
Verify Read permission for the /hr/v2/workers/meta endpoint.
Validate the connection after updating the required API permissions.
6
Error while getting data from ADP table / Sample Profile
Description: The connector could not retrieve worker data for sample profiling or data preview.
Resolution:
Verify read permission for the /hr/v2/workers endpoint.
Retry the operation after confirming API access.
Reduce the sample size if the request is affected by API rate limits.
7
Proxy / Connection Errors
Description: The connector could not establish a network connection to the ADP services.
Resolution:
Enable the Proxy option if the environment requires a proxy server.
Ensure outbound HTTPS access to accounts.adp.com and api.adp.com is allowed.
Verify firewall and network settings that may block the connection.
Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA
Last updated
Was this helpful?