Overview
SFTP (Secure File Transfer Protocol) is a reliable and secure method for transferring files over the internet. ADP will charge a recurring fee to your customer to set up report automation that can be used across one or multiple reports.This guide walks you through setting up an ADP SFTP connection so you can provide exceptional support to your customers.
Step 1: Identify the Required Fields for Your Use Case
Merge's SFTP integration relies on precise field matching to ensure successful data mapping. Any deviations could prevent Merge from mapping those fields correctly.
To streamline the process, Merge provides a comprehensive list of column headers in our SFTP Report Template for all common models and fields currently mapped for ADP SFTP. While not every field may be relevant to your use case, we recommend carefully identifying the necessary fields and sharing this tailored list with your customer. For more details about field mapping, please reach out to your CSM or Merge Support team.
Example Use Case:
Acme.co, an employee compensation platform, integrates with Merge using Employees, Employments, and Groups. Below is a list of fields that would best align with Acme's use case.
ASSOCIATE ID | POSITION ID |
PAYROLL FIRST NAME | EFFECTIVE DATE |
PAYROLL MIDDLE NAME | Position Effective Date |
PAYROLL LAST NAME | JOB TITLE |
NAME | ANNUAL SALARY |
COMPANY CODE | ANNUAL SALARY CURRENCY |
TERMINATION DATE | STATUS |
PREFERRED OR CHOSEN NAME | POSITION STATUS |
LOCATION | WORKER CATEGORY |
WORK E-MAIL | HOME DEPARTMENT |
REHIRE DATE | BUSINESS_UNIT |
HIRE DATE | REPORTS TO NAME |
PERSONAL E-MAIL | REPORTS TO ASSOCIATE ID |
PERSONAL MOBILE | MANAGER EMPLOYEE ID |
STATE / PROVINCE / TERRITORY (WORK ADDRESS) | STATE / PROVINCE / TERRITORY (PRIMARY ADDRESS) |
ADDRESS LINE 1 (WORK ADDRESS) | ADDRESS LINE 1 (PRIMARY ADDRESS) |
ADDRESS LINE 2 (WORK ADDRESS) | ADDRESS LINE 2 (PRIMARY ADDRESS) |
ZIP CODE / POSTAL CODE (WORK ADDRESS) | ZIP CODE / POSTAL CODE (PRIMARY ADDRESS) |
COUNTRY (WORK ADDRESS) | COUNTRY (PRIMARY ADDRESS) |
CITY (PRIMARY ADDRESS) | CITY (PRIMARY ADDRESS) |
Step 2: How your customer selects SFTP in Merge Link
To set up the SFTP connection, your customer must select the option "Custom Reports".
Merge supports manual CSV upload for ADP, but if you'd prefer to have the data update on a regular cadence, your customer must select "Automatically send report".
Step 3: How to assist your customers in filling out ADP's SOW
To establish an automatic connection with ADP, your customer must complete an SOW (Statement of Work) with ADP to formalize the connection.
Merge will provide the necessary technical details, including the username, host name, destination directory, and port in the linking flow. All other fields (Client ID, Security Master, etc.) your customer will be able to fill out.
Once your customer has all provided ADP the required credentials in the SOW, it is important that they exit out of the linking connection to create an Incomplete Link in your Merge dashboard.
Step 4: Authenticating the Connection via ADP provided SSH Key
Once the SOW is submitted, ADP will send your customer an SSH key, which is essential for securely connecting to servers and completing the ADP SFTP integration. The SSH key is linked to the username provided in the SOW, so it’s crucial to keep the linking session unique to the customer and "active."
Your customer will need to input the SSH key into the active connection containing the credentials they shared with ADP. To verify the session is active, check the username in the linking flow to ensure it matches the one in the SOW.
Ensuring the linking session is active and unique:
If Merge Link is embedded in your product: Pass the existing account's
end_user_origin_idto the/link-tokenendpoint to maintain the same credentials.If Merge Link is not embedded in your product: Select "Relink with Magic Link" in your dashboard to refresh the session.