# Integrating with ADP Workforce Now

## Prerequisites

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

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

Drivetrain uses SFTP to integrate ADP Workforce Now to do data ingestion of files. SFTP is a secure and private method to send files over the internet.

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

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fx7p5UdIusl6xJi5IPEj3%2FADPW-1.webp?alt=media&#x26;token=0dcb7183-f580-4ea2-ba72-81e579439ad4" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2FFAkdEjR2Zr5E7NFoo515%2FADPW-2.avif?alt=media&#x26;token=c4575e4c-c594-48f1-b7f1-0da1a2926962" alt=""><figcaption></figcaption></figure>

### 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
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**                               | 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 finalise this report

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fi66m9iN1uzTd4Q0i6v2o%2FADPW-3.webp?alt=media&#x26;token=629cc600-ba5a-41e1-bfe2-0b4112712008" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Sometimes ADP appends a reports total to your custom report. If you see this, please delete the row. ![](https://docs.drivetrain.ai/~gitbook/image?url=https%3A%2F%2F1383008947-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FmByiugojsjqsjrYS7HGI%252Fuploads%252FehnLvfrL92CjhZPmJ3iA%252FUntitled%2520%281%29.png%3Falt%3Dmedia%26token%3Dea924208-fcdf-4938-a3ec-319bae140e6d\&width=583\&dpr=4\&quality=100\&sign=b4a87c75\&sv=2)
{% 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.

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2FnUDvlnP76kbMYi6n1fzs%2FADPW-4.png?alt=media&#x26;token=5522ca0b-f3c7-42cc-a4a8-418e5075648e" alt=""><figcaption></figcaption></figure>

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. Please find details for remaining fields:&#x20;
   1. FTP Username: Reach out to Drivetrain team for Username.&#x20;
   2. Directory: Reach out to Drivetrain team for Username.
   3. Host Name / IP Address: `sftp1.drivetrain.ai`
   4. Port: `22`
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

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2FbjntjquS9RftL0mSMcvg%2FADPW-6.avif?alt=media&#x26;token=3a08e2f8-5e27-46a9-bfdf-1789f2c85dc5" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2FZWZcdQOw53IRbshslrdW%2FAPDW-7.webp?alt=media&#x26;token=0eba4c15-18ad-449b-a453-aa2f48b24450" alt=""><figcaption></figcaption></figure>

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**

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2FNsRJxgYUVj9GiIVYJlRs%2FADPW-8.webp?alt=media&#x26;token=8f174e84-4c38-407b-992f-d4f28163e341" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
That’s it, please note ADP will them 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
