> For the complete documentation index, see [llms.txt](https://integrations.drivetrain.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.drivetrain.ai/integration-guide/readme/hris-and-ats/integrating-with-adp-workforce-now.md).

# Integrating with ADP Workforce Now

Sync ADP Workforce Now data into Drivetrain to keep your headcount models current. Covers the custom employee report and scheduled SFTP export.

[Prerequisites](#prerequisites)

[ADP Workforce Now (SFTP) Setup](#adp-workforce-now-sftp-setup)\
[Create your employee report](#step-1-create-your-employee-report)\
[Add fields to your custom report](#step-2-add-fields-to-your-custom-report)\
[Recurring report transfers using Automatic Export Service](#step-3-recurring-report-transfers-using-automatic-export-service)\
[Scheduling the report](#step-4-scheduling-the-report)

[Troubleshooting](#troubleshooting)

## Prerequisites <a href="#prerequisites" id="prerequisites"></a>

* An active ADP Workforce Now (SFTP) admin account
* Admin privileges in Drivetrain

## ADP Workforce Now (SFTP) Setup <a href="#adp-workforce-now-sftp-setup" id="adp-workforce-now-sftp-setup"></a>

Drivetrain uses [Merge](http://merge.dev/) to integrate ADP Workforce Now, we use SFTP (Secure File Transfer Protocol) to do data ingestion of files. SFTP is a secure and private method to send files over the internet.

{% hint style="info" %}
Please note that Merge does not store any files during this process. All data is sent directly to Drivetrain's warehouse upon completion.
{% endhint %}

In this guide, you will be given detailed instructions on how to create a custom report in ADP with fields that you want to include for your use case.

### Step 1: Create your employee report <a href="#step-1-create-your-employee-report" id="step-1-create-your-employee-report"></a>

1. Log into ADP and click the **Reports & Analytics** tab
2. Then click **Set Up New** under the Custom Reports

![](https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-7e9518e46d13e63cf9e6fc75812b61f16e1eadaf%2FADPW-1.webp?alt=media)

3. In **Set Up New Report** page, set the Report Title to **employee-census**
4. Then click Select Fields to continue

![](https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-278a36c8954e23b9f90264df22e89fc4eba26f34%2FADPW-2.avif?alt=media)

### Step 2: Add fields to your custom report <a href="#step-2-add-fields-to-your-custom-report" id="step-2-add-fields-to-your-custom-report"></a>

1. Add fields to your custom report
2. Search for the field name under **ADD FIELDS,** then \*\*\*\*click the **+** button to add it to the report on the right

{% hint style="warning" %}
You must add **associate id** as a field to the report, it is required to leave associate id checked.
{% endhint %}

3. Below are fields most commonly used in a custom employee report

|                          |                  |
| ------------------------ | ---------------- |
| Associate ID\*           | Race/Ethnicity   |
| Payroll First Name       | Marital Status   |
| Payroll Last Name        | Position ID      |
| Preferred or Chosen Name | File Number      |
| Gender                   | Company Code     |
| Birth Date               | Job Title        |
| Tax ID                   | Business Unit    |
| Primary Address          | Hire Date        |
| Personal E-mail          | Termination Date |
| Home Phone               | Annual Salary    |
| Work Phone               |                  |

\*And other employee fields

|                                                |                                            |
| ---------------------------------------------- | ------------------------------------------ |
| **Associate ID**\* (required)                  | Home Phone Number                          |
| Personal Number                                | Work Phone                                 |
| Preferred or Chosen Name                       | Work Email                                 |
| Date of Birth                                  | Address Line 1 (Primary Address)           |
| Personal Email                                 | Address Line 1 (Work Address)              |
| Status                                         | Address Line 2 (Primary Address)           |
| Address Line 2 (Work Address)                  | City (Work Address)                        |
| City (Primary Address)                         | State/ Province / Territory (Work Address) |
| State / Province / Territory (Primary Address) | Country (Primary Address)                  |
| Zip Code / Postal Code (Primary Address)       | Country (Work Address)                     |
| Zip Code / Postal Code (Work Address)          |                                            |

4. Once you are done with selection, click **Save + Run**, this will take you to View Report screen
5. Click run to finalize this report

![](https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-9c4c1dbadcb82f731c081219d30b48d0c57392dd%2FADPW-3.webp?alt=media)

{% hint style="info" %}
**Checkpoint**: Please note that you have named the report as `employee-census` and have included associate id in the list of fields, both of these requirements needs to be fulfilled for this integration.

Sometimes ADP appends a reports total to your custom report. If you see this, please delete the row. ![](https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-ad862e8146a8438fbf28bac00a1cc42d9411baa2%2Fadp-workforce-now-04.png?alt=media)
{% endhint %}

### Step 3: Recurring report transfers using Automatic Export Service <a href="#step-3-recurring-report-transfers-using-automatic-export-service" id="step-3-recurring-report-transfers-using-automatic-export-service"></a>

1. To automatically send your report on a recurring basis you will need to contact your ADP representative. They will charge a recurring fee to set up report automation that can be used across one or multiple reports. For more information on pricing, please refer to your ADP representative. *Charges may vary but anecdotally we have heard prices range from $500-$750 for one-time setup and $30-$50/month recurring fee.*
2. To set up the automation, you'll need to complete a Statement of Work with ADP to initiate the recurring file transfers (see the example below). Once finalised, ADP will apply the automation to the custom report you previously created. The process typically takes 3-4 weeks to complete.

![](https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-71da0b82342b72ab6cb4805ba502aac29decd3c4%2FADPW-4.png?alt=media)

3. See details below for filling the Client Supplied Information:
   1. **WFN Client ID:** Characters to the right of the @ symbol in your ADP login name
   2. **WFN Security Master:** Person you chose as the Security Master in your ADP instance, this is likely your ADP Admin
   3. **Authentication Level:** Select SSH Key (ADP Provided)
   4. **Date Stamp Required:** Select No
   5. **Required PGP Encryption:** Both are acceptable depending on your preferences, you can read more about PGP Encryption [here](https://www.adpucm.com/pgp).
      1. If PGP encryption is required, you have to create key-pair, after which you can then share the key with ADP.
4. Fill in the remaining fields on the SOW form:
   1. **Host Name/IP Address:** `sftp1.drivetrain.ai`
   2. **Port:** `22`
   3. **FTP Username:** Contact the Drivetrain team for this value.
   4. **Directory:** Contact the Drivetrain team for this value.
5. Once the SOW is completed, ADP will typically respond in 3-4 weeks with confirmation on when the report is to be scheduled and the required SSH Key to authenticate the connection

### Step 4: Scheduling the report <a href="#step-4-scheduling-the-report" id="step-4-scheduling-the-report"></a>

ADP may schedule the reports themselves based on your preferences, but if you would prefer to schedule the report:

1. Go to **Reports & Analytics,** and click on All Custom Reports

![](https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-a442e8afc52f9b37006cc542a74f0f7df484edb7%2FADPW-6.avif?alt=media)

2. Find the custom report and click on the three dots on right, then select **Schedule to Run**

![](https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-7cf2c8ff2659c77f12fe63b6e9cf9a36c8a3828f%2FAPDW-7.webp?alt=media)

3. Fill in the details of the schedule when you want to push data from ADP to drivetrain, after filling all details click on **Apply**

![](https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-21dcd89d1768fc7d09513b47f51d9af5df95f6fe%2FADPW-8.webp?alt=media)

{% hint style="info" %}
That’s it, please note ADP will then provide you an SSH Key which you will need to connect the account.
{% endhint %}

## Troubleshooting <a href="#troubleshooting" id="troubleshooting"></a>

If you are having difficulties sending or receiving the data please first check the following common requirements.

1. Your report must be in .csv format


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://integrations.drivetrain.ai/integration-guide/readme/hris-and-ats/integrating-with-adp-workforce-now.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
