Overview
SFTP (secure file transfer protocol) is a secure and private service for sending files over the internet. You can also securely upload reports on a one-time basis via a manual CSV upload. We utilize full files and delete rows that are not present in each transfer.
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 a custom report in ADP
Log into ADP and click Reports & Analytics
Click Set Up New under the Custom Reports
In Set Up New Report page, set the report title to Employee-Census.csv or Employee_Census.csv
Then click Select Fields to continue
Step 2: Add fields to your custom report
Please work with your vendor on what fields are required for the report. You can find all the fields required for your use case in our SFTP Report Template. Please note that the fields must *exactly* match how they appear in that file.
To add a field:
Search for a field name under ADD FIELDS
Click the + button to add it to the report on the right
Important fields:
ASSOCIATE ID is required to sync Employees
POSITION ID is required to create Employments
When you are done, click Save + Run
This will take you to a View Report screen where you can choose to export as csv
Click Run to finalize this report
Checkpoint
Did you name the report Employee-Census.csv or Employee_Census.csv This is required!
Did you add the ASSOCIATE ID field to your report? This is required to sync Employees!
Sometimes ADP will append a Report Totals to your custom report. If that is the case, please also delete this row.
Step 3: Share your custom report
There are two ways to send your report that you created above:
Option 1: One-time manual CSV upload
If you want to update your employee data with a one-time csv upload simply download the report that you created in Step 2 as a csv. Then upload it into your Linking modal.
Option 2: Recurring report transfers using Automatic Export Service
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 $30-$50/month.
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 finalized, ADP will apply the automation to the custom report you previously created. The process typically takes 3-4 weeks to complete.
How to fill out the SOW:
Please fill out the fields in Client Supplied Information:
WFN Client ID: the characters to the right of the @ symbol in your ADP login name
WFN Security Master: the person you chose as the Security Master in your ADP instance, this is likely your ADP Admin
Authentication Level: SSH Key (ADP Provided)
Date Stamp Required: No
Required PGP Encryption: Both are acceptable depending on your preferences
If PGP encryption is required, your vendor will supply you with a PGP key, which you can then share with ADP.
You will find all other required information for the Statement of Work in your linking modal:
FTP Username
Directory
Host Name
Port
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.
Scheduling the report:
ADP may schedule the reports themselves based on your preferences, but if you would prefer to schedule the report:
Head over to Report & Analytics -> All Custom Reports.
From the Reports main page, find the custom report that you configured and open up the menu. Then select Schedule To Run.
You'll then be in the Schedule and Distribution page. From here you are able to set up a recurring schedule for when your report will be sent. When you're ready, click Apply.
Authorizing the Connection via SSH Key:
*Required* ADP will them provide you an SSH Key which you will need to input into the linking flow:
Step 4: Connection complete
You're done! Once the connection has been established, we will verify that the report has been properly formatted. From there, your data will be synced on the schedule that you configured through ADP!
*Troubleshooting*
If you are having difficulties sending or receiving the data please first check the following common requirements.
Your report name must be exactly "Employee-Census.csv or "Employee_Census.csv"
Your report must have the column "ASSOCIATE ID"
Your report must be in .csv format
Note: We accept files up to 250MB. Please message your support representative if you need to increase this limit.