ADP Workforce Now to JSM Assets

ADP Workforce Now to JSM Assets

Import ADP Workforce Now Data into JSM Assets with OnLink

Use OnLink to import worker profile, contact, employment, and assignment data from ADP Workforce Now into Jira Service Management (JSM) Assets.

Overview

This guide explains how to connect OnLink to ADP Workforce Now, create an Assets import configuration, define ADP-to-Assets field mappings, test the import, and review common configuration options. Follow the steps in order to move from connection setup through production scheduling.

Prerequisites

  • OnLink is installed and available in Jira from Manage your apps.

  • You have access to the target JSM Assets schema and object type.

  • You have ADP Workforce Now API access for your tenant.

  • You have the ADP integration credentials and certificate details listed below.

Required ADP integration details

  • Client ID

  • Client secret

  • Private key

  • Certificate/public key

To generate the certificate pair, follow ADP’s https://developers.adp.com/learn/how-to-articles/generate-a-certificate-signing-request#manual-process-steps-(client-process-steps).

If you do not have the Client ID or Client Secret, contact your ADP client representative. If you use the OnRamp Cloud version and receive the Client ID and Client Secret through Onward, set both the public and private certificate values to USE_ONWARD_PARTNER.

Create the ADP Workforce Now connection

First, create the source system connection in OnLink.

  1. Open OnLink from Manage your apps.

  2. Go to Connections.

  3. Click Add System.

  4. Select HR/Other Assets Sources.

  5. Enter the ADP Client ID, Client secret, Private key, and Certificate/public key.

  6. Save the connection.

  7. Verify that the connection is established successfully before continuing.

Use the screenshot below as a reference when entering the ADP connection details.

image-20240827-004743.png

Set up the Assets import configuration

After the ADP connection is established, create the base Assets import configuration. Review the setup guide: Assets import configuration.

After the base configuration is created, open OnLink from Manage your apps and configure the ADP source and field-level mappings.

Configure the ADP importer

Use the following procedure to configure the importer.

  1. Enter a descriptive name for the mapping.

  2. Set Source system to the ADP Workforce Now connection you created.

  3. Confirm the Asset Schema. OnLink pre-fills this value from the JSM Assets schema where you started the configuration.

  4. Select the target Object Type within the schema.

  5. Select the schedule frequency for automated production runs.

  6. Add the attribute mappings. Use the mapping examples below as a starting point.

  7. Save the importer configuration.

Mapping examples

Basic worker mapping

Use this mapping to import ADP workers into a JSM Assets user or employee object type.

key:workerID.idValue=Worker ID map:person.communication.emails.0.emailUri=Email map:person.legalName.givenName=First Name map:person.legalName.familyName1=Last Name map:workerDates.originalHireDate=Hire Date

Additional worker attributes

Use these mappings when your Assets object type includes additional HR profile attributes.

map:person.legalName.familyName1=Last Name map:person.preferredName=Preferred Name map:person.legalName.givenName=First Name map:person.communication.emails.emailUri=Email map:businessCommunication.emails.0.emailUri=Work Email map:person.legalAddress.countryCode=Country Code map:workerStatus.statusCode.codeValue=Worker Status

Primary assignment JSONPath mappings

Use JSONPath mappings when the required value is inside a repeated ADP collection, such as work assignments or custom fields.

map:jsonpath__workAssignments.*.hireDate__where__workAssignments.*.primaryIndicator_eq_true=HireDate map:jsonpath__workAssignments.*.reportsTo.0.positionID__where__workAssignments.*.primaryIndicator_eq_true=Manager Position ID map:jsonpath__workAssignments.*.reportsTo.0.reportsToWorkerName.formattedName__where__workAssignments.*.primaryIndicator_eq_true=Manager Name map:jsonpath__workAssignments.*.assignmentStatus.statusCode.shortName__where__workAssignments.*.primaryIndicator_eq_true=Assignment Status map:jsonpath__customFieldGroup.stringFields.*.stringValue__where__customFieldGroup.stringFields.*.nameCode.codeValue_eq_Windows Login=Windows ID

Mapping reference

Use the following reference to understand common ADP mapping and configuration entries.

Mapping item

Purpose

Notes

Mapping item

Purpose

Notes

key:workerID.idValue=Worker ID

Uses Worker ID as the unique key for the Assets object.

Required. This lets OnLink update existing worker records instead of creating duplicates.

map:person.communication.emails.0.emailUri=User

Maps the worker email address to a JSM Assets attribute named User.

User can be an Assets attribute of type User. OnLink can use the email address to match the Atlassian user.

map:person.legalName.givenName=First Name

Maps the ADP legal given name to the Assets attribute First Name.

Use the exact Assets attribute name after the equals sign.

map:workerDates.originalHireDate=Hire Date

Maps the original hire date from ADP to the Assets attribute Hire Date.

Ensure the target attribute type supports date values.

config:filter=/mobileUserAccounts/organizationOID eq 'ABCDEFGH'

Limits the workers returned by ADP.

Use an ADP filter that matches the worker population you want to import.

config:api=/hr/v2/worker-demographics

Changes the default /hr/v2/workers API endpoint.

Optional. Use this when you need worker demographic fields from the ADP worker demographics API.

Optional configuration parameters

Parameter

Description

Parameter

Description

config:filter=/mobileUserAccounts/organizationOID eq 'ABCDEFGH'

Adds an ADP filter to limit the workers returned by the import.

config:filter=workers/person/legalName/familyName1 eq 'Smith' config:filter=workers/workAssignments/assignmentStatus/statusCode/codeValue eq 'A'

config:api=/hr/v2/worker-demographics

Uses the ADP worker demographics endpoint instead of the default workers endpoint.

Test and validate the import

OnLink processes data in two separate steps: Get Data and Import Data.

  1. Click Get Data to pull records from ADP Workforce Now into OnLink staging.

  2. Open the job logs and wait for the message: No more pending records. Data will be imported on next Import run.

  3. Click Import Data to create or update objects in JSM Assets.

  4. Review the target object type in JSM Assets and confirm that objects, attributes, and references were imported as expected.

Production runs are fully automated based on the schedule selected in the importer configuration.

image-20240318-045922.png

References