|
|
| (One intermediate revision by the same user not shown) |
| Line 1: |
Line 1: |
| | Integrating ADP into your case takes just a few steps: | | Integrating ADP into your case takes just a few steps: |
| − |
| |
| | <li>Contacting ADP for Required Information | | <li>Contacting ADP for Required Information |
| | <li>Request API Integration User Role | | <li>Request API Integration User Role |
Latest revision as of 19:02, 10 July 2025
Integrating ADP into your case takes just a few steps:
Contacting ADP for Required Information
Request API Integration User Role
Adding ADP Access on the Case
Setting up the ADP Integration
Purchasing the Selerix Application in the ADP Marketplace
Consenting to Data Access
Testing the Integration
Syncing Employee Data
STEP 1: CONTACT ADP FOR REQUIRED INFORMATION
The broker/case builder must request specific information from ADP.
1. Contact your ADP account manager and request API integration with Selerix. ADP will charge a nominal fee (typically less than setting up file exchange) for activating this service.
a. Note that you will have to identify the specific site you are using and may be required to provide the webhook URL (/QX/api/payroll/push/ADP).
See the Webhooks Table for the specific webhook used where your case resides.
2. ADP will provide the OID information to Selerix Support, who can then communicate it to the Broker/Case builder.
STEP 2: REQUEST NEW USER ROLE – API INTEGRATION
Contact Selerix Technical Support and request the API Integration role for your user account.
This provides access to Integrations via the Data Management menu.
STEP 3: ADD ADP ACCESS TO THE CASE
- Select Case Info from the Case Setup menu.
- Click the Access tab.
- Select ADP from the Payroll Administrators list.
- Click Save.
STEP 4: CONFIGURE THE ADP ADAPTER
The Case Builder is responsible for setting up the ADP Integration Adapter on the case.
To create the ADP adapter for API integration with BenSelect:
- Login to your BenSelect site and select the case that is integrating with ADP.
- Go to Data Management >> Integrations. The Integrations page displays options for adding a new integration.
- Click + to create a new integration. The Add Integration dialog box opens.
- Click the Adapter drop-down list and select ADP Integration Provider.
- Click Add. The ADP Adapter Setup page displays options.
Using the information from ADP, enter the required information in each section of the ADP Adapter Setup. Note that hovering your mouse over the label for each field provides additional information about the field.
General Settings
This section allows setup for the following sub sections:
Basic Settings
Users
Error Notifications
Basic Settings
Name Enter the name identifying the ADP configuration in the list of active integrations.
Company – Select the payroll company identified on the plans. Note: If you have defined ADP as a provider, you can set up (in EDI Parameters) deduction codes that are separate from those defined as “Payroll Dept.”
Note: If you have defined ADP as a provider, you can set up (in EDI Parameters) deduction codes that are separate from those defined as “Payroll Dept.” See the section “Setting up EDI Deduction Codes” in this document for more information.
Contact User – Select the user who is responsible for the setup of the integration.
Default User - Select the user that you want to have associated with changes received from ADP.
Polling Interval – Set the period of time between the previous and next sync with the ADP system. We’ll check their side and if there is anything different in the employee demographic information, we’ll bring that over in an inbound event.
Enable Polling – Automatically selected; deselect to turn off the polling function.
Stability Delay – Select the time, in minutes, for the integration to wait in between events for the same employee. Recommended setting is 0.
Deliverable – Associate a deliverable to the integration. This association ensures that any events exchanged via the ADP integration are tracked on the employee’s EDI tab. Additionally, it ensures any issues associated with the integration are displayed on the Home page Deliverables widget.
Postpone if After – Set the date after which no data exchange should occur. This field is used to hold transmission of any deductions later than the given date, as long as the date is in the future.
Enabled - When you have completed the setup, enable the integration by clicking Yes. Leave this option set to No until the integration setup is complete.
Processing – When all adapter configuration is completed, set Enabled to Yes, then set Processing to Play.
Note: If the Enabled setting is set to Yes, but the Processing setting is set to Pause, BenSelect will receive “payloads” (aka decision information), but will not process them. These will be available for viewing on the Integration Dashboard in the Awaiting Approvals section.
Caution: Do not turn off the integration once it has started running. This causes any decision information not to be logged into BenSelect; it would have to be re-sent to the system. However, if the integration is “paused”, the decision information is sent to BenSelect, and can then be processed when the Processing option is set to Play.
Users Settings
Users – Add users to this list if you wish to allow them to change the configuration.
A user’s access to events processed by the configuration is controlled by granting the API integration role to the user. Contact Selerix Technical Support for assistance with this task.
Error Notification Settings
This section contains options for notifications regarding the integration.
Send Error Notifications – Select this option to choose to Send error notifications from the case.
Notification Interval – Select how often error notifications should be sent.
From – This option is preset, based on the user currently logged into the case, going through setup.
To – Select the user to receive the notification.
Add – Click this button to add users to the notification.
Data Settings
This section allows setup for the following sub sections:
• Locations
• Job Class
• Options
• System of Record
Locations Settings
The Locations section allows you to configure the source for the location and the department. These are mapped to fields provided by ADP.
Location Source – Select the source for the location field.
Department Source - Select the source for the Department field.
Location Filtering:
By default, the integration processes all available Company Codes from ADP. Adding a Company Code to the grid limits processing to those listed. If no codes are entered, all companies are included.
ADP Locations act as an additional filter. If a Company Code is listed with a specific ADP Location, only records for that company and location are processed.
Job Class Settings
Job Class Source – Select the source for the Job Class field. Options include: Worker Category, FLSA, Benefits Eligibility Class, and Custom Field.
Note that if the Benefits Eligibility Class is selected as the source, that Webhook notifications are not triggered by changes to this field alone. Synchronization will only occur if the field is part of an update that triggers a notification.
Options Settings
Begin/End Date Processing - Select the date used by the payroll provider to process the deduction. Options include: Coverage Effective Dates, Coverage Deduction Dates, Pay Period Start, Pay Period End, Pay Period Start +1 and Pay Period End -1. Choose the relevant option according to your payroll deduction schedule.
Deduction Mode – Select the option for sending coverage data that applies to the case. All Coverage Data will send all coverage data within the same Add/Change/Delete transaction, while Affected Coverage Data will send only the affected data within the same Add/Change/Delete transaction.
Audo Add Departments – Select to auto-add.
Skip Updates if employee is inactive (terminated) - When selected, terminated employees will not be updated.
Skip Updates After - Set the number of days after which no updates are made.
System of Record Settings
Set Employees to ADP; set Benefits to BenSelect.
Connection Settings
Save the integration after adding the Subscriber OID.
Subscriber OID – Add the value provided by ADP via Selerix Support.
Connection – Select Production.
Auto-sync – Select Inbound Events and/or Outbound Events, to automatically sync the system with these types of events. These changes will be made without any HR/Admin review.
Sync All – If you leave the Auto-sync options deselected, select Sync All will sync all payroll processes.
Sync Settings
Sync Deductions will create a sync event for all deductions on, or prior to the date you perform this action for all locations or for an individual location based on the selected option.
Sync Future Deductions will alter the behavior of Sync Deductions to include deductions with a future start date. This will also change the behavior on the Integration Dashboard, when manually syncing an employee by using the Resend option. You must save the integration settings for changes to this option to take effect.
Sync All Employees will queue an event to fetch the latest demographic information for all employees in ADP.
Note: The setup cannot be fully completed until the customer purchases the Selerix Connector application in the ADP Marketplace. See the next step for further instructions.
STEP 5: PURCHASE THE SELERIX APPLICATION IN THE ADP MARKETPLACE
Selerix Support advises the broker/case builder to purchase the Selerix Connector App in the ADP Marketplace.
The customer will need to provide:
License URL: The base URL of their site (e.g., https://www.benselect.com/).
Case Number: This can be found under Session -> System Info in BenSelect, under the Software Versions section.
STEP 6: CONSENT TO DATA ACCESS
At the end of the checkout process, the broker/case builder will need to follow the steps in ADP to allow consent for the Selerix App to access their data.
If the customer is having trouble finding the consent link, they can access it from the integration configuration page in BenSelect, in the Connection Settings panel.
The direct link to the ADP consent page is:
https://adpapps.adp.com/consent-manager/pending/email?consumerApplicationID=887d64b8-0281-4148-8f11-c8599498b08f
STEP 7: TEST THE INTEGRATION
The case builder will complete the following steps.
- Navigate to Data Management -> Integrations in BenSelect.
- Click the Edit icon next to the ADP Integration.
- In the Connection Settings panel, add the Subscriber OID to the integration in the corresponding field.
- Save the integration after adding the Subscriber OID.
- Use the Test Connection button to verify that the integration can connect and receive data from ADP.
If the connection fails, this is likely due to:
The data consent step is not completed, or
The Subscriber OID is not set or incorrect.
STEP 8: SYNC EMPLOYEE DATA (OPTIONAL)
The broker/case builder can choose to sync all employee data.
In the Sync Settings panel on the integration configuration page, there is a "Sync All Employees" button.
Click this button to queue a process to begin syncing employee data at a rate of 50 employees every 30 minutes.
This step is optional because employee data can also be uploaded to the case via a Census file instead.
Unsupported Features and Additional Notes
The Subscriber OID can only be linked to one case at a time. If the customer wants to set up the ADP integration for multiple cases, they will need to subscribe to the Selerix application for each employer group in ADP and get a different Subscriber OID for each case build.
Limited Sync Fields:
The following fields will only sync from ADP to Selerix when there are other changes in the employee record: Standard Hours, Pay Frequency, Work Phone, and Personal Email.
If the customer wants to update these fields without changing any other data, they can use a custom field as a workaround. For example, they can create a "revisions" field and increment it by one whenever they want to force a sync for these fields.
Deductions:
- The integration does not support making corrections for canceling future deductions. If the customer cancels a future deduction in Selerix, it will terminate the entire plan in ADP, not just the future payments.
- The integration does not support changing the deduction start date for existing deductions in Selerix. If the customer changes the start date of a deduction that has already been sent to ADP, it will not update in ADP and may cause errors or discrepancies.
- The integration does not support administrative changes to the effective date and deduction date of deductions in Selerix. If the customer modifies these dates manually in Selerix, it will result in unexpected behaviors and may cause the payload to error out when sent to ADP.
