Creating an extended integration for ADP Workforce Now users

Let Oomnitza be your single source of truth!

You'll get visibility of your ADP Workforce Now users as data from ADP Workforce Now is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and ADP Workforce Now in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key user information
• Configurable reports to share information about users with your colleagues and management
• Configurable workflows for getting user information.

Navigation

Adding ADP Workforce Now global variables

Adding the credentials

Creating the user integration

Creating custom mappings

Creating workflows

Creating user workflows with the API block

Get User Details

Creating Saas user workflows

User Role preset

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

You will need the following for the Oomnitza integration:

Client Id and Secret

ADP Workforce Now uses OAuth2.0 authentication. A client id and a secret are required to access the service. If you don't have this information, contact your ADP Workforce Now client representative.

The URL of your ADP Workforce Now server

If your Server URL was in the format https://<serverurl>.comthe value that you would enter would be serverurl.

For further information consult the ADP Workforce Now API documentation.

Adding ADP Workforce Now global variables

To save time when you create workflows, set your Server URL as a global variable:

1. From the menu, go to Configuration>General.
2. Click Global Settings.
3. Click Add new variable (+).
4. Add the ADP.ADP WorkForce Now Server Url variable and its value. 
5. Save your changes.

Adding the credentials

To stream ADP Workforce Now user data into Oomnitza, complete the following steps:

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Enter your client credentials and any other additional information.
5. Click Authenticate. You are prompted to log in to authorize your request.
6. Click CREATE.

Information
If the integration is not listed, click Advanced Mode, and add your credentials.

1. Add the information details.
2. Click the AUTHORIZATION tab.
3. Ensure that OAuth 2.0 is selected as the Authorization type.
4. Ensure that ADP WorkForce Now is selected from the SaaS list.
5. Enter the URL of your ADP Workforce Now server. 
6. Enter your Client ID and Client Secret. 
7. Authenticate the connection.
8. Click CREATE. 

You use the credentials that you added to create and customize your ADP Workforce Now (OAuth 2.0) integrations with Oomnitza.

Next

You use the credentials that you added to create and customize your ADP Workforce Now integrations with Oomnitza.

Creating the user integration

1. In Oomnitza, click Configuration>Integrations>Overview.
2. Click Integrations List View
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. Search for the integration in the sidebar or use the Search.
6. Click ADD.

Integration Overview

Before you start

More information is provided about the following fields to help you complete the integration:

Integration preferences:  By default,  Create and Update are selected. To ensure that only live user records are synced with Oomnitza, select Update Only. When you run the integration, you can check the error logs to see the records that weren't uploaded and why they weren't uploaded. Then, you can decide whether to upload the user records that were skipped by changing your integration preference back to Create and Update.
 

User selection: When you select User plus SaaS User and you have multiple instances of the same SaaS, you can choose your SaaS instance from the dropdown. If you have a single instance of the SaaS, your instance is already detected by the system.

Integration details

Procedure
To review or update the integrations details, click the pencil:

1. Update the integration name if necessary. 
2. From the User Selection list, select an option. 
3. For installation type, ensure that Cloud is selected.
4. For integration preferences, select an option.
5. Enter the name of the integration user.

Credential details

Choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Click the pencil.
2. Configure your schedule.
3. Click Update.

Mappings

To map the fields to Oomnitza, click the pencil.

Creating custom mappings

Map the ADP Workforce Now fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

1. Create a custom mapping for the ADP Workforce Now Associate OID. To do this, complete the following steps:
   1. Select the down arrow on the Associate OID field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field to ADP Workforce Now User Id.
   4. Click CREATE. 
2. You have the option to create custom mappings to map any other field that you want to add to Oomnitza. To create an optional custom mapping, do the following:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field.
   4. Click CREATE. 
3. Map and assign a sync key to the Email field.
4. Click NEXT.

Note
For all user loads, it is recommended that you map role information to an employee role in Oomnitza. Users need to have an employee role defined in order to access Oomnitza. If the role information is not available from the user load, it is recommended that you select Employee from the Oomnitza Role dropdown list. You have the option to overwrite this at a later point should the role information become available. 

Standard ADP Workforce Now to Oomnitza mappings

The following ADP Workforce Now fields can be mapped to Oomnitza:

Associate OID
Birth Date
Communication Emails Name Code
Communication Emails Name Code Short Name
Connect: ADP WorkForce Now Server Url
Connect: Credentials
Connector Sync Time
Email
Gender Code
Gender Code Long Name
Gender Code Short Name
Is Disabled Indicator
Is Tobacco User Indicator
Legal Address City Name
Legal Address Country Code
Legal Address Country Subdivision Level1 Code
Legal Address Country Subdivision Level1 Short Name
Legal Address Country Subdivision Level1 Subdivision Type
Legal Address Country Subdivision Level2 Code
Legal Address Country Subdivision Level2 Short Name
Legal Address Country Subdivision Level2 Subdivision Type
Legal Address Line One
Legal Address Line Two
Legal Address Name Code
Legal Address Name Code Short Name
Legal Address Postal Code
Legal Name Family Name1
Legal Name Formatted Name
Legal Name Generation Affix Code
Legal Name Generation Affix Code Short Name
Legal Name Given Name
Legal Name Middle Name
Legal Name Qualification Affix Code
Legal Name Qualification Affix Code Long Name
Marital Status Code
Marital Status Code Effective Date
Marital Status Code Short Name
Military Discharge Date
Original Hire Date
Worker ID
Worker Status Code

Did you know? 
You can define rules for your integration by selecting Edit integration at the top of the screen. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.  

You can add new fields to your integration by selecting the + (Add) option. All you need to do is specify the field name and then enter the JSON path, for example {{response.email}}. See Creating custom API fields. 

Launching the integration

Your integration is in Draft mode until all the required mandatory fields are added. Once you have added all of the required fields, we recommend that you complete the following steps

1. Select Launch to activate your integration.
2. Change your Integration preferences to Update only so that no records are imported and do a Test Run.
3. Click Sync Sessions and review the status of the integration. If you encounter any errors, see troubleshooting integrations.
4. When the test run has been completed, change your Integration preferences and click Run Now.

Getting your results
To view the information that is collected about your assets, click Assets. To view the information about software, click an asset and then click the Software tab. To view the information that is collected about your users, click People. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

Creating workflows

Creating user workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create user workflows with the API block by following the steps in Creating user workflows with the API block. When creating the user workflows with the API block for ADP Workforce Now, the following specific configuration is required:

To locate the available presets, enter ADP Workforce Now in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

1. Your correct ADP Workforce Now Credentials that you created in Adding the credentials.
2. Your ADP Workforce Now Server URL should be derived from the variable created in Adding ADP Workforce Now global variables or entered manually. 

The API workflow block comes with one built-in preset, the ADP Workforce Now Get User Details preset.

Using the ADP Workforce Now Get User Details preset

The ADP Workforce Now Get User preset allows you to retrieve information about users that you have the permission to view. It retrieves unmasked data using the individual Associate Object Identifier (AOID), or Associate OID field that you mapped in Creating custom mappings.

For further information see ADP Workforce Now REST API documentation: Workers.

Creating Saas user workflows

You can create the SaaS User workflow by following the steps in Creating Saas user workflows. When creating the user workflows with the API block for ADP Workforce Now, the following specific configuration is required:

To locate the available presets, enter ADP Workforce Now in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

1. Your correct ADP Workforce Now Credentials that you created in Adding the credentials.
2. Your ADP Workforce Now Server URL.

The SaaS User workflow block comes with one available preset, the ADP Workforce Now User Role preset.

Using the ADP Workforce Now User Role preset

The ADP Workforce Now User Role preset enables you to read a user’s job title from ADP Workforce Now.

For further information on workflows see:
 Understanding workflows
 Workflow block overview

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your users, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.