Step-by-step deployment guide

The ADP connector imports Worker data from your ADP environment into Elimity Insights. Each Worker becomes a Worker entity in Elimity Insights, enriched with their personal & organizational data.

Step-by-step deployment guide

1. Which data is imported from ADP?

The integration with ADP imports the following data per Worker:

Attribute
Object ID
Personnel Number
First Name
Last Name
Formatted Name
Email
Organizational Unit
Employment Subgroup
Cost Center
Cost Center Name
External
Start Date
End Date
Management Position
Manager Name
Job Title
Position
Position ID
Status
Worker Type Name
Worker Type Code

The connector calls the ADP Workers API (/hr/v2/workers) and pages through every worker. For each worker it picks the most relevant work assignment (the most recent active assignment, or the most recently terminated one if no active assignment exists) and maps the attributes above.

2. Request API access from ADP

The connector authenticates against ADP using the OAuth 2.0 client credentials flow combined with mutual TLS (see ADP's Introduction to Mutual SSL for background). The certificate and private key are required because ADP only accepts API calls that present a valid client certificate during the TLS handshake. Without them the connector cannot obtain an access token.

You generate the key pair and the matching Certificate Signing Request (CSR) yourself, then submit only the CSR to ADP for signing. See Generating a Certificate Signing Request for the step-by-step process to follow.

In the end you should have the following configuration values:

• A client_id

• A client_secret

• A client certificate (e.g. a .pem or .crt file)

• The matching private key (e.g. a.pem or .key file)

Tip: Before continuing, you can confirm your client_id, client_secret, certificate and private key actually work by making a quick test call with Postman. ADP's Making your first API call using Postman walks through this. If Postman can fetch a token, the connector will too.

3. Configure the source in Elimity Insights

You can now register the connector in Elimity Insights:

1. Go to Sources in the left navigation bar and click Add Source.

2. Search for Custom and click Set Up.

3. Click Set Up again and give the source a name (e.g. ADP).

4. Select Upload export file, click Continue and upload the data model file: monuta-adp-data-model.json.

adp-data-model-export.json

5KB

Open

1. Open the Config tab and click Edit.

2. Check the Enable automatic imports via custom gateway and fill in the Gateway URL: https://adp-gateway-1027270379075.europe-west1.run.app

3. Click Add configuration value and add the four entries below.

Key	Type
adpClientId	Text
adpClientSecret	Password
adpKey	Secret file
adpCert	Secret file

All four keys are required. If any of them is missing or incorrect, the connector will fail to authenticate against ADP and the import will not start.

1. Click Save and run to launch your first import. You can monitor the progress in the Logs tab, and the Imports tab will show the summary for each run.